openapi: 3.2.0
info:
  title: Elasticsearch ml trained model API
  description: 'Elasticsearch provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features.

    ## Documentation source and versions

    This documentation is derived from the main branch of the elasticsearch-specification repository. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.

    This documentation contains work-in-progress information for future Elastic Stack releases.'
  license:
    name: Apache 2.0
    url: https://github.com/elastic/elasticsearch-specification/blob/main/LICENSE
  version: ''
security:
- apiKeyAuth: []
- basicAuth: []
- bearerAuth: []
tags:
- name: ml trained model
  description: The machine learning trained models APIs enable you to perform model management operations.
  externalDocs:
    description: Learn more.
    url: https://www.elastic.co/docs/explore-analyze/machine-learning/nlp/ml-nlp-overview
  x-displayName: Machine learning trained model
paths:
  /_ml/trained_models/{model_id}/deployment/cache/_clear:
    post:
      tags:
      - ml trained model
      summary: Clear trained model deployment cache
      description: 'Cache will be cleared on all nodes where the trained model is assigned.

        A trained model deployment may have an inference cache enabled.

        As requests are handled by each allocated node, their responses may be cached on that individual node.

        Calling this API clears the caches without restarting the deployment.'
      operationId: ml-clear-trained-model-deployment-cache
      parameters:
      - in: path
        name: model_id
        description: The unique identifier of the trained model.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  cleared:
                    type: boolean
                required:
                - cleared
              examples:
                MlClearTrainedModelDeploymentCacheResponseExample1:
                  description: A successful response when clearing the inference cache.
                  value: "{\n  \"cleared\": true\n}"
      x-state: Generally available; Added in 8.5.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb post\">POST</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}/deployment/cache/_clear</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_ml`

        '
      x-api: clear_trained_model_deployment_cache.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: 'POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/cache/_clear

          '
      - lang: Python
        source: "resp = client.ml.clear_trained_model_deployment_cache(\n    model_id=\"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n)"
      - lang: JavaScript
        source: "const response = await client.ml.clearTrainedModelDeploymentCache({\n  model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n});"
      - lang: Ruby
        source: "response = client.ml.clear_trained_model_deployment_cache(\n  model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\"\n)"
      - lang: PHP
        source: "$resp = $client->ml()->clearTrainedModelDeploymentCache([\n    \"model_id\" => \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n]);"
      - lang: curl
        source: 'curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/cache/_clear"'
      - lang: Java
        source: "client.ml().clearTrainedModelDeploymentCache(c -> c\n    .modelId(\"elastic__distilbert-base-uncased-finetuned-conll03-english\")\n);\n"
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
  /_ml/trained_models/{model_id}:
    get:
      tags:
      - ml trained model
      summary: Get trained model configuration info
      operationId: ml-get-trained-models
      parameters:
      - in: path
        name: model_id
        description: 'The unique identifier of the trained model or a model alias.


          You can get information for multiple trained models in a single API

          request by using a comma-separated list of model IDs or a wildcard

          expression.'
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Ids'
        style: simple
      - in: query
        name: allow_no_match
        description: 'Specifies what to do when the request:


          - Contains wildcard expressions and there are no models that match.

          - Contains the _all string or no identifiers and there are no matches.

          - Contains wildcard expressions and there are only partial matches.


          If true, it returns an empty array when there are no matches and the

          subset of results when there are partial matches.'
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: decompress_definition
        description: 'Specifies whether the included model definition should be returned as a

          JSON map (true) or in a custom compressed format (false).'
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: exclude_generated
        description: 'Indicates if certain fields should be removed from the configuration on

          retrieval. This allows the configuration to be in an acceptable format to

          be retrieved and then added to another cluster.'
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: from
        description: Skips the specified number of models.
        deprecated: false
        schema:
          type: number
        style: form
      - in: query
        name: include
        description: "A comma delimited string of optional fields to include in the response\nbody.\n\nSupported values include:\n  - `definition`: Includes the model definition.\n  - `feature_importance_baseline`: Includes the baseline for feature importance values.\n  - `hyperparameters`: Includes the information about hyperparameters used to train the model.\nThis information consists of the value, the absolute and relative\nimportance of the hyperparameter as well as an indicator of whether it was\nspecified by the user or tuned during hyperparameter optimization.\n  - `total_feature_importance`: Includes the total feature importance for the training data set. The\nbaseline and total feature importance values are returned in the metadata\nfield in the response body.\n  - `definition_status`: Includes the model definition status.\n\n"
        deprecated: false
        schema:
          $ref: '#/components/schemas/ml._types.Include'
        style: form
      - in: query
        name: size
        description: Specifies the maximum number of models to obtain.
        deprecated: false
        schema:
          type: number
        style: form
      - in: query
        name: tags
        description: 'A comma delimited string of tags. A trained model can have many tags, or

          none. When supplied, only trained models that contain all the supplied

          tags are returned.'
        deprecated: false
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: number
                  trained_model_configs:
                    description: An array of trained model resources, which are sorted by the model_id value in ascending order.
                    type: array
                    items:
                      $ref: '#/components/schemas/ml._types.TrainedModelConfig'
                required:
                - count
                - trained_model_configs
      x-state: Generally available; Added in 7.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `monitor_ml`

        '
      x-api: get_trained_models.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: 'GET _ml/trained_models/

          '
      - lang: Python
        source: resp = client.ml.get_trained_models()
      - lang: JavaScript
        source: const response = await client.ml.getTrainedModels();
      - lang: Ruby
        source: response = client.ml.get_trained_models
      - lang: PHP
        source: $resp = $client->ml()->getTrainedModels();
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/trained_models/"'
      - lang: Java
        source: 'client.ml().getTrainedModels(g -> g);

          '
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
    put:
      tags:
      - ml trained model
      summary: Create a trained model
      description: Enable you to supply a trained model that is not created by data frame analytics.
      operationId: ml-put-trained-model
      parameters:
      - in: path
        name: model_id
        description: The unique identifier of the trained model.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: query
        name: defer_definition_decompression
        description: 'If set to `true` and a `compressed_definition` is provided,

          the request defers definition decompression and skips relevant

          validations.'
        deprecated: false
        schema:
          type: boolean
        x-state: Generally available; Added in 8.0.0
        style: form
      - in: query
        name: wait_for_completion
        description: 'Whether to wait for all child operations (e.g. model download)

          to complete.'
        deprecated: false
        schema:
          type: boolean
        x-state: Generally available; Added in 8.8.0
        style: form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                compressed_definition:
                  description: 'The compressed (GZipped and Base64 encoded) inference definition of the

                    model. If compressed_definition is specified, then definition cannot be

                    specified.'
                  type: string
                definition:
                  description: 'The inference definition for the model. If definition is specified, then

                    compressed_definition cannot be specified.'
                  allOf:
                  - $ref: '#/components/schemas/ml.put_trained_model.Definition'
                description:
                  description: A human-readable description of the inference trained model.
                  type: string
                inference_config:
                  description: 'The default configuration for inference. This can be either a regression

                    or classification configuration. It must match the underlying

                    definition.trained_model''s target_type. For pre-packaged models such as

                    ELSER the config is not required.'
                  allOf:
                  - $ref: '#/components/schemas/ml._types.InferenceConfigCreateContainer'
                input:
                  description: The input field names for the model definition.
                  allOf:
                  - $ref: '#/components/schemas/ml.put_trained_model.Input'
                metadata:
                  description: An object map that contains metadata about the model.
                  type: object
                model_type:
                  description: "The model type.\n\nSupported values include:\n  - `tree_ensemble`: The model definition is an ensemble model of decision trees.\n  - `lang_ident`: A special type reserved for language identification models.\n  - `pytorch`: The stored definition is a PyTorch (specifically a TorchScript) model.\nCurrently only NLP models are supported.\n\n"
                  default: tree_ensemble
                  allOf:
                  - $ref: '#/components/schemas/ml._types.TrainedModelType'
                model_size_bytes:
                  description: 'The estimated memory usage in bytes to keep the trained model in memory.

                    This property is supported only if defer_definition_decompression is true

                    or the model definition is not supplied.'
                  type: number
                platform_architecture:
                  description: 'The platform architecture (if applicable) of the trained mode. If the model

                    only works on one platform, because it is heavily optimized for a particular

                    processor architecture and OS combination, then this field specifies which.

                    The format of the string must match the platform identifiers used by Elasticsearch,

                    so one of, `linux-x86_64`, `linux-aarch64`, `darwin-x86_64`, `darwin-aarch64`,

                    or `windows-x86_64`. For portable models (those that work independent of processor

                    architecture or OS features), leave this field unset.'
                  type: string
                tags:
                  description: An array of tags to organize the model.
                  type: array
                  items:
                    type: string
                prefix_strings:
                  description: Optional prefix strings applied at inference
                  x-state: Generally available; Added in 8.12.0
                  allOf:
                  - $ref: '#/components/schemas/ml._types.TrainedModelPrefixStrings'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ml._types.TrainedModelConfig'
      x-state: Generally available; Added in 7.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb put\">PUT</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_ml`

        '
      x-api: put_trained_model.ml
      x-category: ai/ml
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
    delete:
      tags:
      - ml trained model
      summary: Delete an unreferenced trained model
      description: The request deletes a trained inference model that is not referenced by an ingest pipeline.
      operationId: ml-delete-trained-model
      parameters:
      - in: path
        name: model_id
        description: The unique identifier of the trained model.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: query
        name: force
        description: Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment.
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: timeout
        description: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Duration'
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_types.AcknowledgedResponseBase'
              examples:
                MlDeleteTrainedModelResponseExample1:
                  description: A successful response when deleting an existing trained inference model.
                  value: "{\n  \"acknowledged\": true\n}"
      x-state: Generally available; Added in 7.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb delete\">DELETE</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_ml`

        '
      x-api: delete_trained_model.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: 'DELETE _ml/trained_models/regression-job-one-1574775307356

          '
      - lang: Python
        source: "resp = client.ml.delete_trained_model(\n    model_id=\"regression-job-one-1574775307356\",\n)"
      - lang: JavaScript
        source: "const response = await client.ml.deleteTrainedModel({\n  model_id: \"regression-job-one-1574775307356\",\n});"
      - lang: Ruby
        source: "response = client.ml.delete_trained_model(\n  model_id: \"regression-job-one-1574775307356\"\n)"
      - lang: PHP
        source: "$resp = $client->ml()->deleteTrainedModel([\n    \"model_id\" => \"regression-job-one-1574775307356\",\n]);"
      - lang: curl
        source: 'curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/trained_models/regression-job-one-1574775307356"'
      - lang: Java
        source: "client.ml().deleteTrainedModel(d -> d\n    .modelId(\"regression-job-one-1574775307356\")\n);\n"
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
  /_ml/trained_models/{model_id}/model_aliases/{model_alias}:
    put:
      tags:
      - ml trained model
      summary: Create or update a trained model alias
      description: 'A trained model alias is a logical name used to reference a single trained

        model.

        You can use aliases instead of trained model identifiers to make it easier to

        reference your models. For example, you can use aliases in inference

        aggregations and processors.

        An alias must be unique and refer to only a single trained model. However,

        you can have multiple aliases for each trained model.

        If you use this API to update an alias such that it references a different

        trained model ID and the model uses a different type of data frame analytics,

        an error occurs. For example, this situation occurs if you have a trained

        model for regression analysis and a trained model for classification

        analysis; you cannot reassign an alias from one type of trained model to

        another.

        If you use this API to update an alias and there are very few input fields in

        common between the old and new trained models for the model alias, the API

        returns a warning.'
      operationId: ml-put-trained-model-alias
      parameters:
      - in: path
        name: model_id
        description: The identifier for the trained model that the alias refers to.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: path
        name: model_alias
        description: The alias to create or update. This value cannot end in numbers.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Name'
        style: simple
      - in: query
        name: reassign
        description: 'Specifies whether the alias gets reassigned to the specified trained

          model if it is already assigned to a different model. If the alias is

          already assigned and this parameter is false, the API returns an error.'
        deprecated: false
        schema:
          type: boolean
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_types.AcknowledgedResponseBase'
      x-state: Generally available; Added in 7.13.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb put\">PUT</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}/model_aliases/{model_alias}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_ml`

        '
      x-api: put_trained_model_alias.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: 'PUT _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model

          '
      - lang: Python
        source: "resp = client.ml.put_trained_model_alias(\n    model_id=\"flight-delay-prediction-1574775339910\",\n    model_alias=\"flight_delay_model\",\n)"
      - lang: JavaScript
        source: "const response = await client.ml.putTrainedModelAlias({\n  model_id: \"flight-delay-prediction-1574775339910\",\n  model_alias: \"flight_delay_model\",\n});"
      - lang: Ruby
        source: "response = client.ml.put_trained_model_alias(\n  model_id: \"flight-delay-prediction-1574775339910\",\n  model_alias: \"flight_delay_model\"\n)"
      - lang: PHP
        source: "$resp = $client->ml()->putTrainedModelAlias([\n    \"model_id\" => \"flight-delay-prediction-1574775339910\",\n    \"model_alias\" => \"flight_delay_model\",\n]);"
      - lang: curl
        source: 'curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model"'
      - lang: Java
        source: "client.ml().putTrainedModelAlias(p -> p\n    .modelAlias(\"flight_delay_model\")\n    .modelId(\"flight-delay-prediction-1574775339910\")\n);\n"
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
    delete:
      tags:
      - ml trained model
      summary: Delete a trained model alias
      description: 'This API deletes an existing model alias that refers to a trained model. If

        the model alias is missing or refers to a model other than the one identified

        by the `model_id`, this API returns an error.'
      operationId: ml-delete-trained-model-alias
      parameters:
      - in: path
        name: model_id
        description: The trained model ID to which the model alias refers.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: path
        name: model_alias
        description: The model alias to delete.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Name'
        style: simple
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_types.AcknowledgedResponseBase'
              examples:
                MlDeleteTrainedModelAliasResponseExample1:
                  description: A successful response when deleting a trained model alias.
                  value: "{\n  \"acknowledged\": true\n}"
      x-state: Generally available; Added in 7.13.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb delete\">DELETE</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}/model_aliases/{model_alias}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_ml`

        '
      x-api: delete_trained_model_alias.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: 'DELETE _ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model

          '
      - lang: Python
        source: "resp = client.ml.delete_trained_model_alias(\n    model_id=\"flight-delay-prediction-1574775339910\",\n    model_alias=\"flight_delay_model\",\n)"
      - lang: JavaScript
        source: "const response = await client.ml.deleteTrainedModelAlias({\n  model_id: \"flight-delay-prediction-1574775339910\",\n  model_alias: \"flight_delay_model\",\n});"
      - lang: Ruby
        source: "response = client.ml.delete_trained_model_alias(\n  model_id: \"flight-delay-prediction-1574775339910\",\n  model_alias: \"flight_delay_model\"\n)"
      - lang: PHP
        source: "$resp = $client->ml()->deleteTrainedModelAlias([\n    \"model_id\" => \"flight-delay-prediction-1574775339910\",\n    \"model_alias\" => \"flight_delay_model\",\n]);"
      - lang: curl
        source: 'curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/trained_models/flight-delay-prediction-1574775339910/model_aliases/flight_delay_model"'
      - lang: Java
        source: "client.ml().deleteTrainedModelAlias(d -> d\n    .modelAlias(\"flight_delay_model\")\n    .modelId(\"flight-delay-prediction-1574775339910\")\n);\n"
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
  /_ml/trained_models:
    get:
      tags:
      - ml trained model
      summary: Get trained model configuration info
      operationId: ml-get-trained-models-1
      parameters:
      - in: query
        name: allow_no_match
        description: 'Specifies what to do when the request:


          - Contains wildcard expressions and there are no models that match.

          - Contains the _all string or no identifiers and there are no matches.

          - Contains wildcard expressions and there are only partial matches.


          If true, it returns an empty array when there are no matches and the

          subset of results when there are partial matches.'
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: decompress_definition
        description: 'Specifies whether the included model definition should be returned as a

          JSON map (true) or in a custom compressed format (false).'
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: exclude_generated
        description: 'Indicates if certain fields should be removed from the configuration on

          retrieval. This allows the configuration to be in an acceptable format to

          be retrieved and then added to another cluster.'
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: from
        description: Skips the specified number of models.
        deprecated: false
        schema:
          type: number
        style: form
      - in: query
        name: include
        description: "A comma delimited string of optional fields to include in the response\nbody.\n\nSupported values include:\n  - `definition`: Includes the model definition.\n  - `feature_importance_baseline`: Includes the baseline for feature importance values.\n  - `hyperparameters`: Includes the information about hyperparameters used to train the model.\nThis information consists of the value, the absolute and relative\nimportance of the hyperparameter as well as an indicator of whether it was\nspecified by the user or tuned during hyperparameter optimization.\n  - `total_feature_importance`: Includes the total feature importance for the training data set. The\nbaseline and total feature importance values are returned in the metadata\nfield in the response body.\n  - `definition_status`: Includes the model definition status.\n\n"
        deprecated: false
        schema:
          $ref: '#/components/schemas/ml._types.Include'
        style: form
      - in: query
        name: size
        description: Specifies the maximum number of models to obtain.
        deprecated: false
        schema:
          type: number
        style: form
      - in: query
        name: tags
        description: 'A comma delimited string of tags. A trained model can have many tags, or

          none. When supplied, only trained models that contain all the supplied

          tags are returned.'
        deprecated: false
        schema:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: number
                  trained_model_configs:
                    description: An array of trained model resources, which are sorted by the model_id value in ascending order.
                    type: array
                    items:
                      $ref: '#/components/schemas/ml._types.TrainedModelConfig'
                required:
                - count
                - trained_model_configs
      x-state: Generally available; Added in 7.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/_ml/trained_models</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `monitor_ml`

        '
      x-api: get_trained_models.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: 'GET _ml/trained_models/

          '
      - lang: Python
        source: resp = client.ml.get_trained_models()
      - lang: JavaScript
        source: const response = await client.ml.getTrainedModels();
      - lang: Ruby
        source: response = client.ml.get_trained_models
      - lang: PHP
        source: $resp = $client->ml()->getTrainedModels();
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/trained_models/"'
      - lang: Java
        source: 'client.ml().getTrainedModels(g -> g);

          '
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
  /_ml/trained_models/{model_id}/_stats:
    get:
      tags:
      - ml trained model
      summary: Get trained models usage info
      description: 'You can get usage information for multiple trained

        models in a single API request by using a comma-separated list of model IDs or a wildcard expression.'
      operationId: ml-get-trained-models-stats
      parameters:
      - in: path
        name: model_id
        description: 'The unique identifier of the trained model or a model alias. It can be a

          comma-separated list or a wildcard expression.'
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Ids'
        style: simple
      - in: query
        name: allow_no_match
        description: 'Specifies what to do when the request:


          - Contains wildcard expressions and there are no models that match.

          - Contains the _all string or no identifiers and there are no matches.

          - Contains wildcard expressions and there are only partial matches.


          If true, it returns an empty array when there are no matches and the

          subset of results when there are partial matches.'
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: from
        description: Skips the specified number of models.
        deprecated: false
        schema:
          type: number
        style: form
      - in: query
        name: size
        description: Specifies the maximum number of models to obtain.
        deprecated: false
        schema:
          type: number
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    description: The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter.
                    type: number
                  trained_model_stats:
                    description: An array of trained model statistics, which are sorted by the model_id value in ascending order.
                    type: array
                    items:
                      $ref: '#/components/schemas/ml._types.TrainedModelStats'
                required:
                - count
                - trained_model_stats
      x-state: Generally available; Added in 7.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}/_stats</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `monitor_ml`

        '
      x-api: get_trained_models_stats.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: 'GET _ml/trained_models/_stats

          '
      - lang: Python
        source: resp = client.ml.get_trained_models_stats()
      - lang: JavaScript
        source: const response = await client.ml.getTrainedModelsStats();
      - lang: Ruby
        source: response = client.ml.get_trained_models_stats
      - lang: PHP
        source: $resp = $client->ml()->getTrainedModelsStats();
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/trained_models/_stats"'
      - lang: Java
        source: 'client.ml().getTrainedModelsStats(g -> g);

          '
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
  /_ml/trained_models/_stats:
    get:
      tags:
      - ml trained model
      summary: Get trained models usage info
      description: 'You can get usage information for multiple trained

        models in a single API request by using a comma-separated list of model IDs or a wildcard expression.'
      operationId: ml-get-trained-models-stats-1
      parameters:
      - in: query
        name: allow_no_match
        description: 'Specifies what to do when the request:


          - Contains wildcard expressions and there are no models that match.

          - Contains the _all string or no identifiers and there are no matches.

          - Contains wildcard expressions and there are only partial matches.


          If true, it returns an empty array when there are no matches and the

          subset of results when there are partial matches.'
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: from
        description: Skips the specified number of models.
        deprecated: false
        schema:
          type: number
        style: form
      - in: query
        name: size
        description: Specifies the maximum number of models to obtain.
        deprecated: false
        schema:
          type: number
        style: form
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    description: The total number of trained model statistics that matched the requested ID patterns. Could be higher than the number of items in the trained_model_stats array as the size of the array is restricted by the supplied size parameter.
                    type: number
                  trained_model_stats:
                    description: An array of trained model statistics, which are sorted by the model_id value in ascending order.
                    type: array
                    items:
                      $ref: '#/components/schemas/ml._types.TrainedModelStats'
                required:
                - count
                - trained_model_stats
      x-state: Generally available; Added in 7.10.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb get\">GET</span>\n              <span class=\"operation-path\">/_ml/trained_models/_stats</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `monitor_ml`

        '
      x-api: get_trained_models_stats.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: 'GET _ml/trained_models/_stats

          '
      - lang: Python
        source: resp = client.ml.get_trained_models_stats()
      - lang: JavaScript
        source: const response = await client.ml.getTrainedModelsStats();
      - lang: Ruby
        source: response = client.ml.get_trained_models_stats
      - lang: PHP
        source: $resp = $client->ml()->getTrainedModelsStats();
      - lang: curl
        source: 'curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/trained_models/_stats"'
      - lang: Java
        source: 'client.ml().getTrainedModelsStats(g -> g);

          '
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
  /_ml/trained_models/{model_id}/_infer:
    post:
      tags:
      - ml trained model
      summary: Evaluate a trained model
      operationId: ml-infer-trained-model
      parameters:
      - in: path
        name: model_id
        description: The unique identifier of the trained model.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: query
        name: timeout
        description: Controls the amount of time to wait for inference results.
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Duration'
        style: form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                docs:
                  description: 'An array of objects to pass to the model for inference. The objects should contain a fields matching your

                    configured trained model input. Typically, for NLP models, the field name is `text_field`.

                    Currently, for NLP models, only a single value is allowed.'
                  type: array
                  items:
                    type: object
                    additionalProperties:
                      type: object
                inference_config:
                  description: The inference configuration updates to apply on the API call
                  allOf:
                  - $ref: '#/components/schemas/ml._types.InferenceConfigUpdateContainer'
              required:
              - docs
            examples:
              MlInferTrainedModelExample1:
                description: An example body for a `POST _ml/trained_models/lang_ident_model_1/_infer` request.
                value: "{\n  \"docs\":[{\"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"}]\n}"
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  inference_results:
                    type: array
                    items:
                      $ref: '#/components/schemas/ml._types.InferenceResponseResult'
                required:
                - inference_results
      x-state: Generally available; Added in 8.3.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb post\">POST</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}/_infer</span>\n              </div>\n            "
      x-api: infer_trained_model.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: "POST _ml/trained_models/lang_ident_model_1/_infer\n{\n  \"docs\":[{\"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"}]\n}"
      - lang: Python
        source: "resp = client.ml.infer_trained_model(\n    model_id=\"lang_ident_model_1\",\n    docs=[\n        {\n            \"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"\n        }\n    ],\n)"
      - lang: JavaScript
        source: "const response = await client.ml.inferTrainedModel({\n  model_id: \"lang_ident_model_1\",\n  docs: [\n    {\n      text: \"The fool doth think he is wise, but the wise man knows himself to be a fool.\",\n    },\n  ],\n});"
      - lang: Ruby
        source: "response = client.ml.infer_trained_model(\n  model_id: \"lang_ident_model_1\",\n  body: {\n    \"docs\": [\n      {\n        \"text\": \"The fool doth think he is wise, but the wise man knows himself to be a fool.\"\n      }\n    ]\n  }\n)"
      - lang: PHP
        source: "$resp = $client->ml()->inferTrainedModel([\n    \"model_id\" => \"lang_ident_model_1\",\n    \"body\" => [\n        \"docs\" => array(\n            [\n                \"text\" => \"The fool doth think he is wise, but the wise man knows himself to be a fool.\",\n            ],\n        ),\n    ],\n]);"
      - lang: curl
        source: 'curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d ''{"docs":[{"text":"The fool doth think he is wise, but the wise man knows himself to be a fool."}]}'' "$ELASTICSEARCH_URL/_ml/trained_models/lang_ident_model_1/_infer"'
      - lang: Java
        source: "client.ml().inferTrainedModel(i -> i\n    .docs(Map.of(\"text\", JsonData.fromJson(\"\\\"The fool doth think he is wise, but the wise man knows himself to be a fool.\\\"\")))\n    .modelId(\"lang_ident_model_1\")\n);\n"
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
  /_ml/trained_models/{model_id}/definition/{part}:
    put:
      tags:
      - ml trained model
      summary: Create part of a trained model definition
      operationId: ml-put-trained-model-definition-part
      parameters:
      - in: path
        name: model_id
        description: The unique identifier of the trained model.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: path
        name: part
        description: 'The definition part number. When the definition is loaded for inference the definition parts are streamed in the

          order of their part number. The first part must be `0` and the final part must be `total_parts - 1`.'
        required: true
        deprecated: false
        schema:
          type: number
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                definition:
                  description: The definition part for the model. Must be a base64 encoded string.
                  type: string
                total_definition_length:
                  description: The total uncompressed definition length in bytes. Not base64 encoded.
                  type: number
                total_parts:
                  description: The total number of parts that will be uploaded. Must be greater than 0.
                  type: number
              required:
              - definition
              - total_definition_length
              - total_parts
            examples:
              MlPutTrainedModelDefinitionPartExample1:
                description: An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0` request.
                value: "{\n    \"definition\": \"...\",\n    \"total_definition_length\": 265632637,\n    \"total_parts\": 64\n}"
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_types.AcknowledgedResponseBase'
      x-state: Generally available; Added in 8.0.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb put\">PUT</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}/definition/{part}</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_ml`

        '
      x-api: put_trained_model_definition_part.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: "PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0\n{\n    \"definition\": \"...\",\n    \"total_definition_length\": 265632637,\n    \"total_parts\": 64\n}"
      - lang: Python
        source: "resp = client.ml.put_trained_model_definition_part(\n    model_id=\"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n    part=\"0\",\n    definition=\"...\",\n    total_definition_length=265632637,\n    total_parts=64,\n)"
      - lang: JavaScript
        source: "const response = await client.ml.putTrainedModelDefinitionPart({\n  model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n  part: 0,\n  definition: \"...\",\n  total_definition_length: 265632637,\n  total_parts: 64,\n});"
      - lang: Ruby
        source: "response = client.ml.put_trained_model_definition_part(\n  model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n  part: \"0\",\n  body: {\n    \"definition\": \"...\",\n    \"total_definition_length\": 265632637,\n    \"total_parts\": 64\n  }\n)"
      - lang: PHP
        source: "$resp = $client->ml()->putTrainedModelDefinitionPart([\n    \"model_id\" => \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n    \"part\" => \"0\",\n    \"body\" => [\n        \"definition\" => \"...\",\n        \"total_definition_length\" => 265632637,\n        \"total_parts\" => 64,\n    ],\n]);"
      - lang: curl
        source: 'curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d ''{"definition":"...","total_definition_length":265632637,"total_parts":64}'' "$ELASTICSEARCH_URL/_ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/definition/0"'
      - lang: Java
        source: "client.ml().putTrainedModelDefinitionPart(p -> p\n    .definition(\"...\")\n    .modelId(\"elastic__distilbert-base-uncased-finetuned-conll03-english\")\n    .part(0)\n    .totalDefinitionLength(265632637L)\n    .totalParts(64)\n);\n"
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
  /_ml/trained_models/{model_id}/vocabulary:
    put:
      tags:
      - ml trained model
      summary: Create a trained model vocabulary
      description: 'This API is supported only for natural language processing (NLP) models.

        The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition.'
      operationId: ml-put-trained-model-vocabulary
      parameters:
      - in: path
        name: model_id
        description: The unique identifier of the trained model.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                vocabulary:
                  description: The model vocabulary, which must not be empty.
                  type: array
                  items:
                    type: string
                merges:
                  description: The optional model merges if required by the tokenizer.
                  x-state: Generally available; Added in 8.2.0
                  type: array
                  items:
                    type: string
                scores:
                  description: The optional vocabulary value scores if required by the tokenizer.
                  x-state: Generally available; Added in 8.9.0
                  type: array
                  items:
                    type: number
              required:
              - vocabulary
            examples:
              MlPutTrainedModelVocabularyExample1:
                description: An example body for a `PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary` request.
                value: "{\n  \"vocabulary\": [\n    \"[PAD]\",\n    \"[unused0]\",\n  ]\n}"
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/_types.AcknowledgedResponseBase'
      x-state: Generally available; Added in 8.0.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb put\">PUT</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}/vocabulary</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_ml`

        '
      x-api: put_trained_model_vocabulary.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: "PUT _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary\n{\n  \"vocabulary\": [\n    \"[PAD]\",\n    \"[unused0]\",\n  ]\n}"
      - lang: Python
        source: "resp = client.ml.put_trained_model_vocabulary(\n    model_id=\"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n    vocabulary=[\n        \"[PAD]\",\n        \"[unused0]\"\n    ],\n)"
      - lang: JavaScript
        source: "const response = await client.ml.putTrainedModelVocabulary({\n  model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n  vocabulary: [\"[PAD]\", \"[unused0]\"],\n});"
      - lang: Ruby
        source: "response = client.ml.put_trained_model_vocabulary(\n  model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n  body: {\n    \"vocabulary\": [\n      \"[PAD]\",\n      \"[unused0]\"\n    ]\n  }\n)"
      - lang: PHP
        source: "$resp = $client->ml()->putTrainedModelVocabulary([\n    \"model_id\" => \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n    \"body\" => [\n        \"vocabulary\" => array(\n            \"[PAD]\",\n            \"[unused0]\",\n        ),\n    ],\n]);"
      - lang: curl
        source: 'curl -X PUT -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d ''{"vocabulary":["[PAD]","[unused0]"]}'' "$ELASTICSEARCH_URL/_ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/vocabulary"'
      - lang: Java
        source: "client.ml().putTrainedModelVocabulary(p -> p\n    .modelId(\"elastic__distilbert-base-uncased-finetuned-conll03-english\")\n    .vocabulary(List.of(\"[PAD]\",\"[unused0]\"))\n);\n"
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
  /_ml/trained_models/{model_id}/deployment/_start:
    post:
      tags:
      - ml trained model
      summary: Start a trained model deployment
      description: It allocates the model to every machine learning node.
      operationId: ml-start-trained-model-deployment
      parameters:
      - in: path
        name: model_id
        description: The unique identifier of the trained model. Currently, only PyTorch models are supported.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: query
        name: cache_size
        description: 'The inference cache size (in memory outside the JVM heap) per node for the model.

          The default value is the same size as the `model_size_bytes`. To disable the cache,

          `0b` can be provided.'
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.ByteSize'
        style: form
      - in: query
        name: deployment_id
        description: A unique identifier for the deployment of the model.
        deprecated: false
        schema:
          type: string
        x-state: Generally available; Added in 8.8.0
        style: form
      - in: query
        name: number_of_allocations
        description: 'The number of model allocations on each node where the model is deployed.

          All allocations on a node share the same copy of the model in memory but use

          a separate set of threads to evaluate the model.

          Increasing this value generally increases the throughput.

          If this setting is greater than the number of hardware threads

          it will automatically be changed to a value less than the number of hardware threads.

          If adaptive_allocations is enabled, do not set this value, because it’s automatically set.'
        deprecated: false
        schema:
          type: number
        style: form
      - in: query
        name: priority
        description: The deployment priority
        deprecated: false
        schema:
          $ref: '#/components/schemas/ml._types.TrainingPriority'
        style: form
      - in: query
        name: queue_capacity
        description: 'Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds

          this value, new requests are rejected with a 429 error.'
        deprecated: false
        schema:
          type: number
        style: form
      - in: query
        name: threads_per_allocation
        description: 'Sets the number of threads used by each model allocation during inference. This generally increases

          the inference speed. The inference process is a compute-bound process; any number

          greater than the number of available hardware threads on the machine does not increase the

          inference speed. If this setting is greater than the number of hardware threads

          it will automatically be changed to a value less than the number of hardware threads.'
        deprecated: false
        schema:
          type: number
        style: form
      - in: query
        name: timeout
        description: Specifies the amount of time to wait for the model to deploy.
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Duration'
        style: form
      - in: query
        name: wait_for
        description: "Specifies the allocation status to wait for before returning.\n\nSupported values include:\n  - `started`: The trained model is started on at least one node.\n  - `starting`: Trained model deployment is starting but it is not yet deployed on any nodes.\n  - `fully_allocated`: Trained model deployment has started on all valid nodes.\n\n"
        deprecated: false
        schema:
          $ref: '#/components/schemas/ml._types.DeploymentAllocationState'
        style: form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                adaptive_allocations:
                  description: 'Adaptive allocations configuration. When enabled, the number of allocations

                    is set based on the current load.

                    If adaptive_allocations is enabled, do not set the number of allocations manually.'
                  allOf:
                  - $ref: '#/components/schemas/ml._types.AdaptiveAllocationsSettings'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  assignment:
                    allOf:
                    - $ref: '#/components/schemas/ml._types.TrainedModelAssignment'
                required:
                - assignment
      x-state: Generally available; Added in 8.0.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb post\">POST</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}/deployment/_start</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_ml`

        '
      x-api: start_trained_model_deployment.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: 'POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_start?wait_for=started&timeout=1m

          '
      - lang: Python
        source: "resp = client.ml.start_trained_model_deployment(\n    model_id=\"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n    wait_for=\"started\",\n    timeout=\"1m\",\n)"
      - lang: JavaScript
        source: "const response = await client.ml.startTrainedModelDeployment({\n  model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n  wait_for: \"started\",\n  timeout: \"1m\",\n});"
      - lang: Ruby
        source: "response = client.ml.start_trained_model_deployment(\n  model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n  wait_for: \"started\",\n  timeout: \"1m\"\n)"
      - lang: PHP
        source: "$resp = $client->ml()->startTrainedModelDeployment([\n    \"model_id\" => \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n    \"wait_for\" => \"started\",\n    \"timeout\" => \"1m\",\n]);"
      - lang: curl
        source: 'curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_start?wait_for=started&timeout=1m"'
      - lang: Java
        source: "client.ml().startTrainedModelDeployment(s -> s\n    .modelId(\"elastic__distilbert-base-uncased-finetuned-conll03-english\")\n    .timeout(t -> t\n        .offset(1)\n    )\n    .waitFor(DeploymentAllocationState.Started)\n);\n"
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
  /_ml/trained_models/{model_id}/deployment/_stop:
    post:
      tags:
      - ml trained model
      summary: Stop a trained model deployment
      operationId: ml-stop-trained-model-deployment
      parameters:
      - in: path
        name: model_id
        description: The unique identifier of the trained model.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: query
        name: allow_no_match
        description: 'Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;

          contains the  `_all` string or no identifiers and there are no matches; or contains wildcard expressions and

          there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches.

          If `false`, the request returns a 404 status code when there are no matches or only partial matches.'
        deprecated: false
        schema:
          type: boolean
        style: form
      - in: query
        name: force
        description: 'Forcefully stops the deployment, even if it is used by ingest pipelines. You can''t use these pipelines until you

          restart the model deployment.'
        deprecated: false
        schema:
          type: boolean
        style: form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  description: If provided, must be the same identifier as in the path.
                  allOf:
                  - $ref: '#/components/schemas/_types.Id'
                allow_no_match:
                  description: 'Specifies what to do when the request: contains wildcard expressions and there are no deployments that match;

                    contains the  `_all` string or no identifiers and there are no matches; or contains wildcard expressions and

                    there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches.

                    If `false`, the request returns a 404 status code when there are no matches or only partial matches.'
                  default: true
                  type: boolean
                force:
                  description: 'Forcefully stops the deployment, even if it is used by ingest pipelines. You can''t use these pipelines until you

                    restart the model deployment.'
                  default: false
                  type: boolean
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopped:
                    type: boolean
                required:
                - stopped
      x-state: Generally available; Added in 8.0.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb post\">POST</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}/deployment/_stop</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_ml`

        '
      x-api: stop_trained_model_deployment.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: 'POST _ml/trained_models/my_model_for_search/deployment/_stop

          '
      - lang: Python
        source: "resp = client.ml.stop_trained_model_deployment(\n    model_id=\"my_model_for_search\",\n)"
      - lang: JavaScript
        source: "const response = await client.ml.stopTrainedModelDeployment({\n  model_id: \"my_model_for_search\",\n});"
      - lang: Ruby
        source: "response = client.ml.stop_trained_model_deployment(\n  model_id: \"my_model_for_search\"\n)"
      - lang: PHP
        source: "$resp = $client->ml()->stopTrainedModelDeployment([\n    \"model_id\" => \"my_model_for_search\",\n]);"
      - lang: curl
        source: 'curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_ml/trained_models/my_model_for_search/deployment/_stop"'
      - lang: Java
        source: "client.ml().stopTrainedModelDeployment(s -> s\n    .modelId(\"my_model_for_search\")\n);\n"
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
  /_ml/trained_models/{model_id}/deployment/_update:
    post:
      tags:
      - ml trained model
      summary: Update a trained model deployment
      operationId: ml-update-trained-model-deployment
      parameters:
      - in: path
        name: model_id
        description: The unique identifier of the trained model. Currently, only PyTorch models are supported.
        required: true
        deprecated: false
        schema:
          $ref: '#/components/schemas/_types.Id'
        style: simple
      - in: query
        name: number_of_allocations
        description: 'The number of model allocations on each node where the model is deployed.

          All allocations on a node share the same copy of the model in memory but use

          a separate set of threads to evaluate the model.

          Increasing this value generally increases the throughput.

          If this setting is greater than the number of hardware threads

          it will automatically be changed to a value less than the number of hardware threads.'
        deprecated: false
        schema:
          type: number
        style: form
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                number_of_allocations:
                  description: 'The number of model allocations on each node where the model is deployed.

                    All allocations on a node share the same copy of the model in memory but use

                    a separate set of threads to evaluate the model.

                    Increasing this value generally increases the throughput.

                    If this setting is greater than the number of hardware threads

                    it will automatically be changed to a value less than the number of hardware threads.

                    If adaptive_allocations is enabled, do not set this value, because it’s automatically set.'
                  default: 1.0
                  type: number
                adaptive_allocations:
                  description: 'Adaptive allocations configuration. When enabled, the number of allocations

                    is set based on the current load.

                    If adaptive_allocations is enabled, do not set the number of allocations manually.'
                  allOf:
                  - $ref: '#/components/schemas/ml._types.AdaptiveAllocationsSettings'
            examples:
              MlUpdateTrainedModelDeploymentExample1:
                description: An example body for a `POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update` request.
                value: "{\n  \"number_of_allocations\": 4\n}"
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  assignment:
                    allOf:
                    - $ref: '#/components/schemas/ml._types.TrainedModelAssignment'
                required:
                - assignment
      x-state: Generally available; Added in 8.6.0
      x-variations:
      - "<div>\n              <span class=\"operation-verb post\">POST</span>\n              <span class=\"operation-path\">/_ml/trained_models/{model_id}/deployment/_update</span>\n              </div>\n            "
      x-req-auth:
      - 'Cluster privileges: `manage_ml`

        '
      x-api: update_trained_model_deployment.ml
      x-category: ai/ml
      x-codeSamples:
      - lang: Console
        source: "POST _ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update\n{\n  \"number_of_allocations\": 4\n}"
      - lang: Python
        source: "resp = client.ml.update_trained_model_deployment(\n    model_id=\"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n    number_of_allocations=4,\n)"
      - lang: JavaScript
        source: "const response = await client.ml.updateTrainedModelDeployment({\n  model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n  number_of_allocations: 4,\n});"
      - lang: Ruby
        source: "response = client.ml.update_trained_model_deployment(\n  model_id: \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n  body: {\n    \"number_of_allocations\": 4\n  }\n)"
      - lang: PHP
        source: "$resp = $client->ml()->updateTrainedModelDeployment([\n    \"model_id\" => \"elastic__distilbert-base-uncased-finetuned-conll03-english\",\n    \"body\" => [\n        \"number_of_allocations\" => 4,\n    ],\n]);"
      - lang: curl
        source: 'curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d ''{"number_of_allocations":4}'' "$ELASTICSEARCH_URL/_ml/trained_models/elastic__distilbert-base-uncased-finetuned-conll03-english/deployment/_update"'
      - lang: Java
        source: "client.ml().updateTrainedModelDeployment(u -> u\n    .modelId(\"elastic__distilbert-base-uncased-finetuned-conll03-english\")\n    .numberOfAllocations(4)\n);\n"
      x-metaTags:
      - content: Elasticsearch, Machine Learning
        name: product_name
components:
  schemas:
    _types.ScriptSort:
      type: object
      properties:
        order:
          description: "\n\nSupported values include:\n  - `asc`: Ascending (smallest to largest)\n  - `desc`: Descending (largest to smallest)\n\n"
          allOf:
          - $ref: '#/components/schemas/_types.SortOrder'
        script:
          allOf:
          - $ref: '#/components/schemas/_types.Script'
        type:
          allOf:
          - $ref: '#/components/schemas/_types.ScriptSortType'
        mode:
          allOf:
          - $ref: '#/components/schemas/_types.SortMode'
        nested:
          allOf:
          - $ref: '#/components/schemas/_types.NestedSortValue'
      required:
      - script
    _types.aggregations.GeoLineAggregation:
      type: object
      properties:
        point:
          description: The name of the geo_point field.
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.GeoLinePoint'
        sort:
          description: 'The name of the numeric field to use as the sort key for ordering the points.

            When the `geo_line` aggregation is nested inside a `time_series` aggregation, this field defaults to `@timestamp`, and any other value will result in error.'
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.GeoLineSort'
        include_sort:
          description: When `true`, returns an additional array of the sort values in the feature properties.
          type: boolean
        sort_order:
          description: "The order in which the line is sorted (ascending or descending).\n\nSupported values include:\n  - `asc`: Ascending (smallest to largest)\n  - `desc`: Descending (largest to smallest)\n\n"
          default: asc
          allOf:
          - $ref: '#/components/schemas/_types.SortOrder'
        size:
          description: 'The maximum length of the line represented in the aggregation.

            Valid sizes are between 1 and 10000.'
          default: 10000.0
          type: number
      required:
      - point
    _types.query_dsl.GeoExecution:
      type: string
      enum:
      - memory
      - indexed
    _types.query_dsl.TermQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          value:
            description: Term you wish to find in the provided field.
            allOf:
            - $ref: '#/components/schemas/_types.FieldValue'
          case_insensitive:
            description: 'Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.

              When `false`, the case sensitivity of matching depends on the underlying field’s mapping.'
            default: false
            x-state: Generally available; Added in 7.10.0
            type: boolean
        required:
        - value
    _types.LinearRetriever:
      allOf:
      - $ref: '#/components/schemas/_types.RetrieverBase'
      - type: object
        properties:
          retrievers:
            description: Inner retrievers.
            type: array
            items:
              $ref: '#/components/schemas/_types.InnerRetriever'
          rank_window_size:
            type: number
          query:
            type: string
          fields:
            type: array
            items:
              type: string
          normalizer:
            allOf:
            - $ref: '#/components/schemas/_types.ScoreNormalizer'
    _types.GeoTilePrecision:
      type: number
    _types.ScalarValue:
      description: A scalar value.
      oneOf:
      - type: number
      - type: number
      - type: string
      - type: boolean
      - type:
        - string
        - 'null'
    ml._types.TrainedModelInferenceFeatureImportance:
      type: object
      properties:
        feature_name:
          type: string
        importance:
          type: number
        classes:
          type: array
          items:
            $ref: '#/components/schemas/ml._types.TrainedModelInferenceClassImportance'
      required:
      - feature_name
    ml._types.TextExpansionInferenceUpdateOptions:
      type: object
      properties:
        tokenization:
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpTokenizationUpdateOptions'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
    _types.aggregations.DiversifiedSamplerAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          execution_hint:
            description: "The type of value used for de-duplication.\n\nSupported values include:\n  - `map`: Hold field values directly.\n  - `global_ordinals`: Hold ordinals of the field as determined by the Lucene index.\n  - `bytes_hash`: Hold hashes of the field values - with potential for hash collisions.\n\n"
            default: global_ordinals
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.SamplerAggregationExecutionHint'
          max_docs_per_value:
            description: Limits how many documents are permitted per choice of de-duplicating value.
            default: 1.0
            type: number
          script:
            allOf:
            - $ref: '#/components/schemas/_types.Script'
          shard_size:
            description: Limits how many top-scoring documents are collected in the sample processed on each shard.
            default: 100.0
            type: number
          field:
            description: The field used to provide values used for de-duplication.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
    _types.Metadata:
      type: object
      additionalProperties:
        type: object
    _types.aggregations.TimeSeriesAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          size:
            description: The maximum number of results to return.
            default: 10000.0
            type: number
          keyed:
            description: Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.
            type: boolean
    _types.query_dsl.MatchQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          analyzer:
            description: Analyzer used to convert the text in the query value into tokens.
            type: string
          auto_generate_synonyms_phrase_query:
            description: If `true`, match phrase queries are automatically created for multi-term synonyms.
            default: true
            type: boolean
          cutoff_frequency:
            deprecated: true
            type: number
          fuzziness:
            description: Maximum edit distance allowed for matching.
            allOf:
            - $ref: '#/components/schemas/_types.Fuzziness'
          fuzzy_rewrite:
            description: Method used to rewrite the query.
            allOf:
            - $ref: '#/components/schemas/_types.MultiTermQueryRewrite'
          fuzzy_transpositions:
            description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
            default: true
            type: boolean
          lenient:
            description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.
            default: false
            type: boolean
          max_expansions:
            description: Maximum number of terms to which the query will expand.
            default: 50.0
            type: number
          minimum_should_match:
            description: Minimum number of clauses that must match for a document to be returned.
            allOf:
            - $ref: '#/components/schemas/_types.MinimumShouldMatch'
          operator:
            description: Boolean logic used to interpret text in the query value.
            default: '''or'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.Operator'
          prefix_length:
            description: Number of beginning characters left unchanged for fuzzy matching.
            default: 0.0
            type: number
          query:
            description: Text, number, boolean value or date you wish to find in the provided field.
            oneOf:
            - type: string
            - type: number
            - type: boolean
          zero_terms_query:
            description: "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n  - `all`: Returns all documents, similar to a `match_all` query.\n  - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n"
            default: '''none'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery'
        required:
        - query
    _types.aggregations.FormattableMetricAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
        properties:
          format:
            type: string
    ml.put_trained_model.Definition:
      type: object
      properties:
        preprocessors:
          description: Collection of preprocessors
          type: array
          items:
            $ref: '#/components/schemas/ml.put_trained_model.Preprocessor'
        trained_model:
          description: The definition of the trained model.
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.TrainedModel'
      required:
      - trained_model
    _types.aggregations.LinearMovingAverageAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase'
      - type: object
        properties:
          model:
            type: string
            enum:
            - linear
          settings:
            allOf:
            - $ref: '#/components/schemas/_types.EmptyObject'
        required:
        - model
        - settings
    _types.aggregations.CompositeHistogramAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase'
      - type: object
        properties:
          interval:
            type: number
        required:
        - interval
    ml.put_trained_model.Weights:
      type: object
      properties:
        weights:
          type: number
      required:
      - weights
    _types.query_dsl.IntervalsFuzzy:
      type: object
      properties:
        analyzer:
          description: Analyzer used to normalize the term.
          type: string
        fuzziness:
          description: Maximum edit distance allowed for matching.
          default: auto
          allOf:
          - $ref: '#/components/schemas/_types.Fuzziness'
        prefix_length:
          description: Number of beginning characters left unchanged when creating expansions.
          default: 0.0
          type: number
        term:
          description: The term to match.
          type: string
        transpositions:
          description: Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`).
          default: true
          type: boolean
        use_field:
          description: 'If specified, match intervals from this field rather than the top-level field.

            The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.'
          allOf:
          - $ref: '#/components/schemas/_types.Field'
      required:
      - term
    _types.aggregations.InferenceConfigContainer:
      type: object
      properties:
        regression:
          description: Regression configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.RegressionInferenceOptions'
        classification:
          description: Classification configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.ClassificationInferenceOptions'
      minProperties: 1
      maxProperties: 1
    ml._types.TrainedModelLocation:
      type: object
      properties:
        index:
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelLocationIndex'
      required:
      - index
    ml._types.TextEmbeddingInferenceOptions:
      description: Text embedding inference options
      type: object
      properties:
        embedding_size:
          description: The number of dimensions in the embedding output
          type: number
        tokenization:
          description: The tokenization options
          allOf:
          - $ref: '#/components/schemas/ml._types.TokenizationConfigContainer'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        vocabulary:
          allOf:
          - $ref: '#/components/schemas/ml._types.Vocabulary'
    _types.SlicedScroll:
      type: object
      properties:
        field:
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        id:
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        max:
          type: number
      required:
      - id
      - max
    _types.mapping.RuntimeFieldType:
      type: string
      enum:
      - boolean
      - composite
      - date
      - double
      - geo_point
      - geo_shape
      - ip
      - keyword
      - long
      - lookup
    _types.query_dsl.GeoPolygonQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          validation_method:
            description: "\n\nSupported values include:\n  - `coerce`: Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.\n  - `ignore_malformed`: Accept geo points with invalid latitude or longitude.\n  - `strict`\n\n"
            default: '''strict'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.GeoValidationMethod'
          ignore_unmapped:
            type: boolean
    _types.aggregations.IpRangeAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          field:
            description: The date field whose values are used to build ranges.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          ranges:
            description: Array of IP ranges.
            type: array
            items:
              $ref: '#/components/schemas/_types.aggregations.IpRangeAggregationRange'
    ml._types.TrainedModelAssignment:
      type: object
      properties:
        adaptive_allocations:
          oneOf:
          - $ref: '#/components/schemas/ml._types.AdaptiveAllocationsSettings'
          - type:
            - string
            - 'null'
        assignment_state:
          description: "The overall assignment state.\n\nSupported values include:\n  - `started`: The deployment is usable; at least one node has the model allocated.\n  - `starting`: The deployment has recently started but is not yet usable; the model is not allocated on any nodes.\n  - `stopping`: The deployment is preparing to stop and deallocate the model from the relevant nodes.\n  - `failed`: The deployment is on a failed state and must be re-deployed.\n\n"
          allOf:
          - $ref: '#/components/schemas/ml._types.DeploymentAssignmentState'
        max_assigned_allocations:
          type: number
        reason:
          type: string
        routing_table:
          description: The allocation state for each node.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ml._types.TrainedModelAssignmentRoutingTable'
        start_time:
          description: The timestamp when the deployment started.
          allOf:
          - $ref: '#/components/schemas/_types.DateTime'
        task_parameters:
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelAssignmentTaskParameters'
      required:
      - assignment_state
      - routing_table
      - start_time
      - task_parameters
    _types.query_dsl.RangeQueryBasedouble:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          relation:
            description: "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n  - `within`: Matches documents with a range field value entirely within the query’s range.\n  - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n  - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n"
            default: intersects
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.RangeRelation'
          gt:
            description: Greater than.
            type: number
          gte:
            description: Greater than or equal to.
            type: number
          lt:
            description: Less than.
            type: number
          lte:
            description: Less than or equal to.
            type: number
    _types.aggregations.BucketScriptAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          script:
            description: The script to run for this aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.Script'
    _types.query_dsl.TermsSetQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          minimum_should_match:
            description: Specification describing number of matching terms required to return a document.
            x-state: Generally available; Added in 8.10.0
            allOf:
            - $ref: '#/components/schemas/_types.MinimumShouldMatch'
          minimum_should_match_field:
            description: Numeric field containing the number of matching terms required to return a document.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          minimum_should_match_script:
            description: Custom script containing the number of matching terms required to return a document.
            allOf:
            - $ref: '#/components/schemas/_types.Script'
          terms:
            description: Array of terms you wish to find in the provided field.
            type: array
            items:
              $ref: '#/components/schemas/_types.FieldValue'
        required:
        - terms
    ml._types.TrainingPriority:
      type: string
      enum:
      - normal
      - low
    _types.aggregations.TTestType:
      type: string
      enum:
      - paired
      - homoscedastic
      - heteroscedastic
    _types.query_dsl.GeoShapeQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          ignore_unmapped:
            description: '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.'
            default: false
            type: boolean
    _types.aggregations.MatrixAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.Aggregation'
      - type: object
        properties:
          fields:
            description: An array of fields for computing the statistics.
            allOf:
            - $ref: '#/components/schemas/_types.Fields'
          missing:
            description: 'The value to apply to documents that do not have a value.

              By default, documents without a value are ignored.'
            type: object
            additionalProperties:
              type: number
    _types.query_dsl.Like:
      description: Text that we want similar documents for or a lookup to a document's field for the text.
      oneOf:
      - type: string
      - $ref: '#/components/schemas/_types.query_dsl.LikeDocument'
    _types.query_dsl.MultiMatchQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          analyzer:
            description: Analyzer used to convert the text in the query value into tokens.
            type: string
          auto_generate_synonyms_phrase_query:
            description: If `true`, match phrase queries are automatically created for multi-term synonyms.
            default: true
            type: boolean
          cutoff_frequency:
            deprecated: true
            type: number
          fields:
            description: 'The fields to be queried.

              Defaults to the `index.query.default_field` index settings, which in turn defaults to `*`.'
            allOf:
            - $ref: '#/components/schemas/_types.Fields'
          fuzziness:
            description: Maximum edit distance allowed for matching.
            allOf:
            - $ref: '#/components/schemas/_types.Fuzziness'
          fuzzy_rewrite:
            description: Method used to rewrite the query.
            allOf:
            - $ref: '#/components/schemas/_types.MultiTermQueryRewrite'
          fuzzy_transpositions:
            description: '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.'
            default: true
            type: boolean
          lenient:
            description: If `true`, format-based errors, such as providing a text query value for a numeric field, are ignored.
            default: false
            type: boolean
          max_expansions:
            description: Maximum number of terms to which the query will expand.
            default: 50.0
            type: number
          minimum_should_match:
            description: Minimum number of clauses that must match for a document to be returned.
            allOf:
            - $ref: '#/components/schemas/_types.MinimumShouldMatch'
          operator:
            description: Boolean logic used to interpret text in the query value.
            default: '''or'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.Operator'
          prefix_length:
            description: Number of beginning characters left unchanged for fuzzy matching.
            default: 0.0
            type: number
          query:
            description: Text, number, boolean value or date you wish to find in the provided field.
            type: string
          slop:
            description: Maximum number of positions allowed between matching tokens.
            default: 0.0
            type: number
          tie_breaker:
            description: Determines how scores for each per-term blended query and scores across groups are combined.
            default: 0.0
            type: number
          type:
            description: "How `the` multi_match query is executed internally.\n\nSupported values include:\n  - `best_fields`: Finds documents that match any field, but uses the `_score` from the best field.\n  - `most_fields`: Finds documents that match any field and combines the `_score` from each field.\n  - `cross_fields`: Treats fields with the same analyzer as though they were one big field.\nLooks for each word in any field.\n  - `phrase`: Runs a `match_phrase` query on each field and uses the `_score` from the best field.\n  - `phrase_prefix`: Runs a `match_phrase_prefix` query on each field and uses the `_score` from the best field.\n  - `bool_prefix`: Creates a `match_bool_prefix` query on each field and combines the `_score` from each field.\n\n"
            default: '''best_fields'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.TextQueryType'
          zero_terms_query:
            description: "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n  - `all`: Returns all documents, similar to a `match_all` query.\n  - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n"
            default: '''none'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery'
        required:
        - query
    _types.Field:
      description: Path to field or array of paths. Some API's support wildcards in the path to select multiple fields.
      type: string
    _types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator:
      type: object
      properties:
        doc_count:
          description: 'The total number of documents that initially created the expectations. It’s required to be greater

            than or equal to the sum of all values in the buckets_path as this is the originating superset of data

            to which the term values are correlated.'
          type: number
        expectations:
          description: 'An array of numbers with which to correlate the configured `bucket_path` values.

            The length of this value must always equal the number of buckets returned by the `bucket_path`.'
          type: array
          items:
            type: number
        fractions:
          description: 'An array of fractions to use when averaging and calculating variance. This should be used if

            the pre-calculated data and the buckets_path have known gaps. The length of fractions, if provided,

            must equal expectations.'
          type: array
          items:
            type: number
      required:
      - doc_count
      - expectations
    _types.aggregations.SumAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase'
      - type: object
    _types.QueryVector:
      type: array
      items:
        type: number
    _types.query_dsl.RuleQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          organic:
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          ruleset_ids:
            oneOf:
            - $ref: '#/components/schemas/_types.Id'
            - type: array
              items:
                $ref: '#/components/schemas/_types.Id'
          ruleset_id:
            type: string
          match_criteria:
            type: object
        required:
        - organic
        - match_criteria
    _types.Duration:
      externalDocs:
        url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/api-conventions#time-units
      description: '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.'
      oneOf:
      - type: string
      - type: string
        enum:
        - '-1'
      - type: string
        enum:
        - '0'
    _types.GeoLocation:
      description: 'A latitude/longitude as a 2 dimensional point. It can be represented in various ways:

        - as a `{lat, long}` object

        - as a geo hash value

        - as a `[lon, lat]` array

        - as a string in `"<lat>, <lon>"` or WKT point formats'
      oneOf:
      - $ref: '#/components/schemas/_types.LatLonGeoLocation'
      - $ref: '#/components/schemas/_types.GeoHashLocation'
      - type: array
        items:
          type: number
      - type: string
    _types.aggregations.ScriptedMetricAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
        properties:
          combine_script:
            description: 'Runs once on each shard after document collection is complete.

              Allows the aggregation to consolidate the state returned from each shard.'
            allOf:
            - $ref: '#/components/schemas/_types.Script'
          init_script:
            description: 'Runs prior to any collection of documents.

              Allows the aggregation to set up any initial state.'
            allOf:
            - $ref: '#/components/schemas/_types.Script'
          map_script:
            description: 'Run once per document collected.

              If no `combine_script` is specified, the resulting state needs to be stored in the `state` object.'
            allOf:
            - $ref: '#/components/schemas/_types.Script'
          params:
            description: 'A global object with script parameters for `init`, `map` and `combine` scripts.

              It is shared between the scripts.'
            type: object
            additionalProperties:
              type: object
          reduce_script:
            description: 'Runs once on the coordinating node after all shards have returned their results.

              The script is provided with access to a variable `states`, which is an array of the result of the `combine_script` on each shard.'
            allOf:
            - $ref: '#/components/schemas/_types.Script'
    _types.aggregations.DateRangeAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          field:
            description: The date field whose values are use to build ranges.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          format:
            description: The date format used to format `from` and `to` in the response.
            type: string
          missing:
            description: 'The value to apply to documents that do not have a value.

              By default, documents without a value are ignored.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.Missing'
          ranges:
            description: Array of date ranges.
            type: array
            items:
              $ref: '#/components/schemas/_types.aggregations.DateRangeExpression'
          time_zone:
            description: Time zone used to convert dates from another time zone to UTC.
            allOf:
            - $ref: '#/components/schemas/_types.TimeZone'
          keyed:
            description: Set to `true` to associate a unique string key with each bucket and returns the ranges as a hash rather than an array.
            type: boolean
    _types.query_dsl.MatchPhrasePrefixQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          analyzer:
            description: Analyzer used to convert text in the query value into tokens.
            type: string
          max_expansions:
            description: Maximum number of terms to which the last provided term of the query value will expand.
            default: 50.0
            type: number
          query:
            description: Text you wish to find in the provided field.
            type: string
          slop:
            description: Maximum number of positions allowed between matching tokens.
            default: 0.0
            type: number
          zero_terms_query:
            description: "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n  - `all`: Returns all documents, similar to a `match_all` query.\n  - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n"
            default: none
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery'
        required:
        - query
    _types.SortCombinations:
      oneOf:
      - $ref: '#/components/schemas/_types.Field'
      - $ref: '#/components/schemas/_types.SortOptions'
    _types.query_dsl.DateDistanceFeatureQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQueryBaseDateMathDuration'
      - type: object
    _types.query_dsl.ExistsQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          field:
            description: Name of the field you wish to search.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
        required:
        - field
    _types.aggregations.PipelineAggregationBase:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketPathAggregation'
      - type: object
        properties:
          format:
            description: '`DecimalFormat` pattern for the output value.

              If specified, the formatted value is returned in the aggregation’s `value_as_string` property.'
            type: string
          gap_policy:
            description: "Policy to apply when gaps are found in the data.\n\nSupported values include:\n  - `skip`: Treats missing data as if the bucket does not exist. It will skip the bucket and\ncontinue calculating using the next available value.\n  - `insert_zeros`: Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal.\n  - `keep_values`: Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,\notherwise the empty bucket is skipped.\n\n"
            default: skip
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GapPolicy'
    _types.aggregations.WeightedAverageValue:
      type: object
      properties:
        field:
          description: The field from which to extract the values or weights.
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        missing:
          description: A value or weight to use if the field is missing.
          type: number
        script:
          allOf:
          - $ref: '#/components/schemas/_types.Script'
    _types.GeoHashLocation:
      type: object
      properties:
        geohash:
          allOf:
          - $ref: '#/components/schemas/_types.GeoHash'
      required:
      - geohash
    _types.aggregations.FormatMetricAggregationBase:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
        properties:
          format:
            type: string
    _types.aggregations.BucketsPath:
      description: 'Buckets path can be expressed in different ways, and an aggregation may accept some or all of these

        forms depending on its type. Please refer to each aggregation''s documentation to know what buckets

        path forms they accept.'
      oneOf:
      - type: string
      - type: array
        items:
          type: string
      - type: object
        additionalProperties:
          type: string
    _global.search._types.HighlightField:
      allOf:
      - $ref: '#/components/schemas/_global.search._types.HighlightBase'
      - type: object
        properties:
          fragment_offset:
            type: number
          matched_fields:
            allOf:
            - $ref: '#/components/schemas/_types.Fields'
    _types.query_dsl.ScriptScoreFunction:
      type: object
      properties:
        script:
          description: A script that computes a score.
          allOf:
          - $ref: '#/components/schemas/_types.Script'
      required:
      - script
    ml._types.TrainedModelConfig:
      type: object
      properties:
        model_id:
          description: Identifier for the trained model.
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        model_type:
          description: "The model type\n\nSupported values include:\n  - `tree_ensemble`: The model definition is an ensemble model of decision trees.\n  - `lang_ident`: A special type reserved for language identification models.\n  - `pytorch`: The stored definition is a PyTorch (specifically a TorchScript) model.\nCurrently only NLP models are supported.\n\n"
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelType'
        tags:
          description: A comma delimited string of tags. A trained model can have many tags, or none.
          type: array
          items:
            type: string
        version:
          description: The Elasticsearch version number in which the trained model was created.
          allOf:
          - $ref: '#/components/schemas/_types.VersionString'
        compressed_definition:
          type: string
        created_by:
          description: Information on the creator of the trained model.
          type: string
        create_time:
          description: The time when the trained model was created.
          allOf:
          - $ref: '#/components/schemas/_types.DateTime'
        default_field_map:
          description: Any field map described in the inference configuration takes precedence.
          type: object
          additionalProperties:
            type: string
        description:
          description: The free-text description of the trained model.
          type: string
        estimated_heap_memory_usage_bytes:
          description: The estimated heap usage in bytes to keep the trained model in memory.
          type: number
        estimated_operations:
          description: The estimated number of operations to use the trained model.
          type: number
        fully_defined:
          description: True if the full model definition is present.
          type: boolean
        inference_config:
          description: The default configuration for inference. This can be either a regression, classification, or one of the many NLP focused configurations. It must match the underlying definition.trained_model's target_type. For pre-packaged models such as ELSER the config is not required.
          allOf:
          - $ref: '#/components/schemas/ml._types.InferenceConfigCreateContainer'
        input:
          description: The input field names for the model definition.
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelConfigInput'
        license_level:
          description: The license level of the trained model.
          type: string
        metadata:
          description: An object containing metadata about the trained model. For example, models created by data frame analytics contain analysis_config and input objects.
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelConfigMetadata'
        model_size_bytes:
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
        model_package:
          allOf:
          - $ref: '#/components/schemas/ml._types.ModelPackageConfig'
        location:
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelLocation'
        platform_architecture:
          type: string
        prefix_strings:
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelPrefixStrings'
      required:
      - model_id
      - tags
      - input
    _types.aggregations.MatrixStatsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MatrixAggregation'
      - type: object
        properties:
          mode:
            description: Array value the aggregation will use for array or multi-valued fields.
            default: avg
            allOf:
            - $ref: '#/components/schemas/_types.SortMode'
    _types.query_dsl.QueryBase:
      type: object
      properties:
        boost:
          description: '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.'
          default: 1.0
          type: number
        _name:
          type: string
    ml._types.PassThroughInferenceOptions:
      description: Pass through configuration options
      type: object
      properties:
        tokenization:
          description: The tokenization options
          allOf:
          - $ref: '#/components/schemas/ml._types.TokenizationConfigContainer'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        vocabulary:
          allOf:
          - $ref: '#/components/schemas/ml._types.Vocabulary'
    _types.TopLeftBottomRightGeoBounds:
      type: object
      properties:
        top_left:
          allOf:
          - $ref: '#/components/schemas/_types.GeoLocation'
        bottom_right:
          allOf:
          - $ref: '#/components/schemas/_types.GeoLocation'
      required:
      - top_left
      - bottom_right
    _types.TokenPruningConfig:
      type: object
      properties:
        tokens_freq_ratio_threshold:
          description: Tokens whose frequency is more than this threshold times the average frequency of all tokens in the specified field are considered outliers and pruned.
          default: 5.0
          type: number
        tokens_weight_threshold:
          description: Tokens whose weight is less than this threshold are considered nonsignificant and pruned.
          default: 0.4
          type: number
        only_score_pruned_tokens:
          description: Whether to only score pruned tokens, vs only scoring kept tokens.
          default: false
          type: boolean
    _global.search._types.Highlight:
      allOf:
      - $ref: '#/components/schemas/_global.search._types.HighlightBase'
      - type: object
        properties:
          encoder:
            allOf:
            - $ref: '#/components/schemas/_global.search._types.HighlighterEncoder'
          fields:
            oneOf:
            - type: object
              additionalProperties:
                $ref: '#/components/schemas/_global.search._types.HighlightField'
              minProperties: 1
              maxProperties: 1
            - type: array
              items:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/_global.search._types.HighlightField'
                minProperties: 1
                maxProperties: 1
        required:
        - fields
    ml._types.TrainedModelStats:
      type: object
      properties:
        deployment_stats:
          description: A collection of deployment stats, which is present when the models are deployed.
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelDeploymentStats'
        inference_stats:
          description: A collection of inference stats fields.
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelInferenceStats'
        ingest:
          description: 'A collection of ingest stats for the model across all nodes.

            The values are summations of the individual node statistics.

            The format matches the ingest section in the nodes stats API.'
          type: object
          additionalProperties:
            type: object
        model_id:
          description: The unique identifier of the trained model.
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        model_size_stats:
          description: A collection of model size stats.
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelSizeStats'
        pipeline_count:
          description: The number of ingest pipelines that currently refer to the model.
          type: number
      required:
      - model_id
      - model_size_stats
      - pipeline_count
    _types.query_dsl.SpanMultiTermQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          match:
            description: Should be a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query).
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
        required:
        - match
    _types.mapping.RuntimeField:
      type: object
      properties:
        fields:
          description: For type `composite`
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.mapping.CompositeSubField'
        fetch_fields:
          description: For type `lookup`
          type: array
          items:
            $ref: '#/components/schemas/_types.mapping.RuntimeFieldFetchFields'
        format:
          description: A custom format for `date` type runtime fields.
          type: string
        input_field:
          description: For type `lookup`
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        target_field:
          description: For type `lookup`
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        target_index:
          description: For type `lookup`
          allOf:
          - $ref: '#/components/schemas/_types.IndexName'
        script:
          description: Painless script executed at query time.
          allOf:
          - $ref: '#/components/schemas/_types.Script'
        type:
          description: 'Field type, which can be: `boolean`, `composite`, `date`, `double`, `geo_point`, `ip`,`keyword`, `long`, or `lookup`.'
          allOf:
          - $ref: '#/components/schemas/_types.mapping.RuntimeFieldType'
      required:
      - type
    _types.SortOrder:
      type: string
      enum:
      - asc
      - desc
    _global.search._types.FieldCollapse:
      type: object
      properties:
        field:
          description: The field to collapse the result set on
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        inner_hits:
          description: The number of inner hits and their sort order
          oneOf:
          - $ref: '#/components/schemas/_global.search._types.InnerHits'
          - type: array
            items:
              $ref: '#/components/schemas/_global.search._types.InnerHits'
        max_concurrent_group_searches:
          description: The number of concurrent requests allowed to retrieve the inner_hits per group
          type: number
        collapse:
          allOf:
          - $ref: '#/components/schemas/_global.search._types.FieldCollapse'
      required:
      - field
    _types.query_dsl.ShapeQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          ignore_unmapped:
            description: When set to `true` the query ignores an unmapped field and will not match any documents.
            type: boolean
    _types.SortMode:
      type: string
      enum:
      - min
      - max
      - sum
      - avg
      - median
    ml._types.TotalFeatureImportance:
      type: object
      properties:
        feature_name:
          description: The feature for which this importance was calculated.
          allOf:
          - $ref: '#/components/schemas/_types.Name'
        importance:
          description: A collection of feature importance statistics related to the training data set for this particular feature.
          type: array
          items:
            $ref: '#/components/schemas/ml._types.TotalFeatureImportanceStatistics'
        classes:
          description: If the trained model is a classification model, feature importance statistics are gathered per target class value.
          type: array
          items:
            $ref: '#/components/schemas/ml._types.TotalFeatureImportanceClass'
      required:
      - feature_name
      - importance
      - classes
    _types.aggregations.ExtendedStatsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase'
      - type: object
        properties:
          sigma:
            description: The number of standard deviations above/below the mean to display.
            type: number
    _types.PinnedRetriever:
      allOf:
      - $ref: '#/components/schemas/_types.RetrieverBase'
      - type: object
        properties:
          retriever:
            description: Inner retriever.
            allOf:
            - $ref: '#/components/schemas/_types.RetrieverContainer'
          ids:
            type: array
            items:
              type: string
          docs:
            type: array
            items:
              $ref: '#/components/schemas/_types.SpecifiedDocument'
          rank_window_size:
            type: number
        required:
        - retriever
    _global.search._types.ScoreMode:
      type: string
      enum:
      - avg
      - max
      - min
      - multiply
      - total
    _types.TransportAddress:
      type: string
    _types.query_dsl.FunctionScoreContainer:
      allOf:
      - type: object
        properties:
          filter:
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          weight:
            type: number
      - type: object
        properties:
          exp:
            description: Function that scores a document with a exponential decay, depending on the distance of a numeric field value of the document from an origin.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.DecayFunction'
          gauss:
            description: Function that scores a document with a normal decay, depending on the distance of a numeric field value of the document from an origin.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.DecayFunction'
          linear:
            description: Function that scores a document with a linear decay, depending on the distance of a numeric field value of the document from an origin.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.DecayFunction'
          field_value_factor:
            description: 'Function allows you to use a field from a document to influence the score.

              It’s similar to using the script_score function, however, it avoids the overhead of scripting.'
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.FieldValueFactorScoreFunction'
          random_score:
            description: 'Generates scores that are uniformly distributed from 0 up to but not including 1.

              In case you want scores to be reproducible, it is possible to provide a `seed` and `field`.'
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.RandomScoreFunction'
          script_score:
            description: Enables you to wrap another query and customize the scoring of it optionally with a computation derived from other numeric field values in the doc using a script expression.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.ScriptScoreFunction'
        minProperties: 1
        maxProperties: 1
    ml._types.Hyperparameter:
      type: object
      properties:
        absolute_importance:
          description: A positive number showing how much the parameter influences the variation of the loss function. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.
          type: number
        name:
          description: Name of the hyperparameter.
          allOf:
          - $ref: '#/components/schemas/_types.Name'
        relative_importance:
          description: A number between 0 and 1 showing the proportion of influence on the variation of the loss function among all tuned hyperparameters. For hyperparameters with values that are not specified by the user but tuned during hyperparameter optimization.
          type: number
        supplied:
          description: Indicates if the hyperparameter is specified by the user (true) or optimized (false).
          type: boolean
        value:
          description: The value of the hyperparameter, either optimized or specified by the user.
          type: number
      required:
      - name
      - supplied
      - value
    _types.Fuzziness:
      oneOf:
      - type: string
      - type: number
    _types.aggregations.PercentilesBucketAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          percents:
            description: The list of percentiles to calculate.
            type: array
            items:
              type: number
    ml._types.TextClassificationInferenceOptions:
      description: Text classification configuration options
      type: object
      properties:
        num_top_classes:
          description: Specifies the number of top class predictions to return. Defaults to 0.
          type: number
        tokenization:
          description: The tokenization options
          allOf:
          - $ref: '#/components/schemas/ml._types.TokenizationConfigContainer'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        classification_labels:
          description: Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels
          type: array
          items:
            type: string
        vocabulary:
          allOf:
          - $ref: '#/components/schemas/ml._types.Vocabulary'
    ml._types.DiscoveryNodeContent:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/_types.Name'
        ephemeral_id:
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        transport_address:
          allOf:
          - $ref: '#/components/schemas/_types.TransportAddress'
        external_id:
          type: string
        attributes:
          type: object
          additionalProperties:
            type: string
        roles:
          type: array
          items:
            type: string
        version:
          allOf:
          - $ref: '#/components/schemas/_types.VersionString'
        min_index_version:
          type: number
        max_index_version:
          type: number
      required:
      - ephemeral_id
      - transport_address
      - external_id
      - attributes
      - roles
      - version
      - min_index_version
      - max_index_version
    _types.query_dsl.GeoValidationMethod:
      type: string
      enum:
      - coerce
      - ignore_malformed
      - strict
    _types.EmptyObject:
      description: For empty Class assignments
      type: object
    _global.search._types.Suggester:
      type: object
      properties:
        text:
          description: Global suggest text, to avoid repetition when the same text is used in several suggesters
          type: string
    _types.Ids:
      oneOf:
      - $ref: '#/components/schemas/_types.Id'
      - type: array
        items:
          $ref: '#/components/schemas/_types.Id'
    _global.search._types.LearningToRank:
      type: object
      properties:
        model_id:
          description: The unique identifier of the trained model uploaded to Elasticsearch
          type: string
        params:
          description: Named parameters to be passed to the query templates used for feature
          type: object
          additionalProperties:
            type: object
      required:
      - model_id
    _types.TopRightBottomLeftGeoBounds:
      type: object
      properties:
        top_right:
          allOf:
          - $ref: '#/components/schemas/_types.GeoLocation'
        bottom_left:
          allOf:
          - $ref: '#/components/schemas/_types.GeoLocation'
      required:
      - top_right
      - bottom_left
    _types.aggregations.MovingAverageAggregationBase:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          minimize:
            type: boolean
          predict:
            type: number
          window:
            type: number
    _types.MultiTermQueryRewrite:
      type: string
    _types.query_dsl.IntervalsFilter:
      type: object
      properties:
        after:
          description: Query used to return intervals that follow an interval from the `filter` rule.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer'
        before:
          description: Query used to return intervals that occur before an interval from the `filter` rule.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer'
        contained_by:
          description: Query used to return intervals contained by an interval from the `filter` rule.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer'
        containing:
          description: Query used to return intervals that contain an interval from the `filter` rule.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer'
        not_contained_by:
          description: Query used to return intervals that are **not** contained by an interval from the `filter` rule.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer'
        not_containing:
          description: Query used to return intervals that do **not** contain an interval from the `filter` rule.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer'
        not_overlapping:
          description: Query used to return intervals that do **not** overlap with an interval from the `filter` rule.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer'
        overlapping:
          description: Query used to return intervals that overlap with an interval from the `filter` rule.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer'
        script:
          description: 'Script used to return matching documents.

            This script must return a boolean value: `true` or `false`.'
          allOf:
          - $ref: '#/components/schemas/_types.Script'
      minProperties: 1
      maxProperties: 1
    _types.query_dsl.SpanQuery:
      type: object
      properties:
        span_containing:
          description: Accepts a list of span queries, but only returns those spans which also match a second span query.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanContainingQuery'
        span_field_masking:
          description: Allows queries like `span_near` or `span_or` across different fields.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery'
        span_first:
          description: Accepts another span query whose matches must appear within the first N positions of the field.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanFirstQuery'
        span_gap:
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanGapQuery'
        span_multi:
          description: Wraps a `term`, `range`, `prefix`, `wildcard`, `regexp`, or `fuzzy` query.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanMultiTermQuery'
        span_near:
          description: Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanNearQuery'
        span_not:
          description: Wraps another span query, and excludes any documents which match that query.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanNotQuery'
        span_or:
          description: Combines multiple span queries and returns documents which match any of the specified queries.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanOrQuery'
        span_term:
          description: The equivalent of the `term` query but for use with other span queries.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.SpanTermQuery'
          minProperties: 1
          maxProperties: 1
        span_within:
          description: The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanWithinQuery'
      minProperties: 1
      maxProperties: 1
    _global.search._types.SourceConfig:
      description: Defines how to fetch a source. Fetching can be disabled entirely, or the source can be filtered.
      oneOf:
      - type: boolean
      - $ref: '#/components/schemas/_global.search._types.SourceFilter'
    ml._types.TrainedModelType:
      type: string
      enum:
      - tree_ensemble
      - lang_ident
      - pytorch
    _types.query_dsl.SparseVectorQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - externalDocs:
          url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query
        allOf:
        - type: object
          properties:
            field:
              description: 'The name of the field that contains the token-weight pairs to be searched against.

                This field must be a mapped sparse_vector field.'
              allOf:
              - $ref: '#/components/schemas/_types.Field'
            query:
              description: 'The query text you want to use for search.

                If inference_id is specified, query must also be specified.'
              type: string
            prune:
              description: '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'
              x-state: Generally available; Added in 8.15.0
              type: boolean
            pruning_config:
              description: 'Optional pruning configuration.

                If enabled, this will omit non-significant tokens from the query in order to improve query performance.

                This is only used if prune is set to true.

                If prune is set to true but pruning_config is not specified, default values will be used.'
              x-state: Generally available; Added in 8.15.0
              allOf:
              - $ref: '#/components/schemas/_types.TokenPruningConfig'
          required:
          - field
        - type: object
          properties:
            query_vector:
              description: 'Dictionary of precomputed sparse vectors and their associated weights.

                Only one of inference_id or query_vector may be supplied in a request.'
              type: object
              additionalProperties:
                type: number
            inference_id:
              description: 'The inference ID to use to convert the query text into token-weight pairs.

                It must be the same inference ID that was used to create the tokens from the input text.

                Only one of inference_id and query_vector is allowed.

                If inference_id is specified, query must also be specified.

                Only one of inference_id or query_vector may be supplied in a request.'
              allOf:
              - $ref: '#/components/schemas/_types.Id'
          minProperties: 1
          maxProperties: 1
    ml._types.RoutingState:
      type: string
      enum:
      - failed
      - started
      - starting
      - stopped
      - stopping
    _types.query_dsl.SpanOrQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          clauses:
            description: Array of one or more other span type queries.
            type: array
            items:
              $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
        required:
        - clauses
    _types.aggregations.TermsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          collect_mode:
            description: "Determines how child aggregations should be calculated: breadth-first or depth-first.\n\nSupported values include:\n  - `depth_first`: Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs.\n  - `breadth_first`: Caches the set of documents that fall into the uppermost buckets for subsequent replay.\n\n"
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsAggregationCollectMode'
          exclude:
            description: 'Values to exclude.

              Accepts regular expressions and partitions.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsExclude'
          execution_hint:
            description: Determines whether the aggregation will use field values directly or global ordinals.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsAggregationExecutionHint'
          field:
            description: The field from which to return terms.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          include:
            description: 'Values to include.

              Accepts regular expressions and partitions.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsInclude'
          min_doc_count:
            description: Only return values that are found in more than `min_doc_count` hits.
            default: 1.0
            type: number
          missing:
            description: 'The value to apply to documents that do not have a value.

              By default, documents without a value are ignored.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.Missing'
          missing_order:
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MissingOrder'
          missing_bucket:
            type: boolean
          value_type:
            description: Coerced unmapped fields into the specified type.
            type: string
          order:
            description: 'Specifies the sort order of the buckets.

              Defaults to sorting by descending document count.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.AggregateOrder'
          script:
            allOf:
            - $ref: '#/components/schemas/_types.Script'
          shard_min_doc_count:
            description: '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`.'
            type: number
          shard_size:
            description: '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.'
            type: number
          show_term_doc_count_error:
            description: 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.
            type: boolean
          size:
            description: The number of buckets returned out of the overall terms list.
            default: 10.0
            type: number
          format:
            type: string
    _types.aggregations.PValueHeuristic:
      type: object
      properties:
        background_is_superset:
          type: boolean
        normalize_above:
          description: 'Should the results be normalized when above the given value.

            Allows for consistent significance results at various scales.

            Note: `0` is a special value which means no normalization'
          default: 0.0
          type: number
    _types.query_dsl.SpanWithinQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          big:
            description: 'Can be any span query.

              Matching spans from `little` that are enclosed within `big` are returned.'
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
          little:
            description: 'Can be any span query.

              Matching spans from `little` that are enclosed within `big` are returned.'
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
        required:
        - big
        - little
    _types.query_dsl.IntervalsAllOf:
      type: object
      properties:
        intervals:
          description: An array of rules to combine. All rules must produce a match in a document for the overall source to match.
          type: array
          items:
            $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer'
        max_gaps:
          description: 'Maximum number of positions between the matching terms.

            Intervals produced by the rules further apart than this are not considered matches.'
          default: -1.0
          type: number
        ordered:
          description: If `true`, intervals produced by the rules should appear in the order in which they are specified.
          default: false
          type: boolean
        filter:
          description: Rule used to filter returned intervals.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsFilter'
      required:
      - intervals
    _types.query_dsl.DisMaxQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          queries:
            description: '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.'
            type: array
            items:
              $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          tie_breaker:
            description: Floating point number between 0 and 1.0 used to increase the relevance scores of documents matching multiple query clauses.
            default: 0.0
            type: number
        required:
        - queries
    _types.SortOptions:
      type: object
      properties:
        _score:
          allOf:
          - $ref: '#/components/schemas/_types.ScoreSort'
        _doc:
          allOf:
          - $ref: '#/components/schemas/_types.ScoreSort'
        _geo_distance:
          allOf:
          - $ref: '#/components/schemas/_types.GeoDistanceSort'
        _script:
          allOf:
          - $ref: '#/components/schemas/_types.ScriptSort'
      minProperties: 1
      maxProperties: 1
    _types.mapping.CompositeSubField:
      type: object
      properties:
        type:
          allOf:
          - $ref: '#/components/schemas/_types.mapping.RuntimeFieldType'
      required:
      - type
    _types.query_dsl.IntervalsWildcard:
      type: object
      properties:
        analyzer:
          description: 'Analyzer used to analyze the `pattern`.

            Defaults to the top-level field''s analyzer.'
          type: string
        pattern:
          description: Wildcard pattern used to find matching terms.
          type: string
        use_field:
          description: 'If specified, match intervals from this field rather than the top-level field.

            The `pattern` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.'
          allOf:
          - $ref: '#/components/schemas/_types.Field'
      required:
      - pattern
    ml.put_trained_model.FrequencyEncodingPreprocessor:
      type: object
      properties:
        field:
          type: string
        feature_name:
          type: string
        frequency_map:
          type: object
          additionalProperties:
            type: number
      required:
      - field
      - feature_name
      - frequency_map
    _types.DurationValueUnitFloatMillis:
      allOf:
      - $ref: '#/components/schemas/_types.UnitFloatMillis'
    _types.LatLonGeoLocation:
      type: object
      properties:
        lat:
          description: Latitude
          type: number
        lon:
          description: Longitude
          type: number
      required:
      - lat
      - lon
    _types.aggregations.GeoLineSort:
      type: object
      properties:
        field:
          description: The name of the numeric field to use as the sort key for ordering the points.
          allOf:
          - $ref: '#/components/schemas/_types.Field'
      required:
      - field
    _types.query_dsl.SemanticQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          field:
            description: The field to query, which must be a semantic_text field type
            type: string
          query:
            description: The query text
            type: string
        required:
        - field
        - query
    _types.query_dsl.UntypedRangeQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBase'
      - type: object
        properties:
          format:
            description: Date format used to convert `date` values in the query.
            allOf:
            - $ref: '#/components/schemas/_types.DateFormat'
          time_zone:
            description: Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.
            allOf:
            - $ref: '#/components/schemas/_types.TimeZone'
    _types.aggregations.HoltWintersModelSettings:
      type: object
      properties:
        alpha:
          type: number
        beta:
          type: number
        gamma:
          type: number
        pad:
          type: boolean
        period:
          type: number
        type:
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.HoltWintersType'
    ml.put_trained_model.TrainedModelTreeNode:
      type: object
      properties:
        decision_type:
          type: string
        default_left:
          type: boolean
        leaf_value:
          type: number
        left_child:
          type: number
        node_index:
          type: number
        right_child:
          type: number
        split_feature:
          type: number
        split_gain:
          type: number
        threshold:
          type: number
      required:
      - node_index
    _types.aggregations.TTestAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.Aggregation'
      - type: object
        properties:
          a:
            description: Test population A.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TestPopulation'
          b:
            description: Test population B.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TestPopulation'
          type:
            description: "The type of test.\n\nSupported values include:\n  - `paired`: Performs paired t-test.\n  - `homoscedastic`: Performs two-sample equal variance test.\n  - `heteroscedastic`: Performs two-sample unequal variance test.\n\n"
            default: heteroscedastic
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TTestType'
    _types.query_dsl.DateRangeQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBaseDateMath'
      - type: object
        properties:
          format:
            description: Date format used to convert `date` values in the query.
            allOf:
            - $ref: '#/components/schemas/_types.DateFormat'
          time_zone:
            description: Coordinated Universal Time (UTC) offset or IANA time zone used to convert `date` values in the query to UTC.
            allOf:
            - $ref: '#/components/schemas/_types.TimeZone'
    ml.put_trained_model.AggregateOutput:
      type: object
      properties:
        logistic_regression:
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.Weights'
        weighted_sum:
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.Weights'
        weighted_mode:
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.Weights'
        exponent:
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.Weights'
    _global.search._types.HighlighterFragmenter:
      type: string
      enum:
      - simple
      - span
    _types.aggregations.TDigest:
      type: object
      properties:
        compression:
          description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.
          type: number
        execution_hint:
          description: 'The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).

            To use an implementation optimized for accuracy, set this parameter to high_accuracy instead.'
          default: default
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.TDigestExecutionHint'
    _types.ScoreNormalizer:
      type: string
      enum:
      - none
      - minmax
      - l2_norm
    _types.query_dsl.CommonTermsQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          analyzer:
            type: string
          cutoff_frequency:
            type: number
          high_freq_operator:
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.Operator'
          low_freq_operator:
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.Operator'
          minimum_should_match:
            allOf:
            - $ref: '#/components/schemas/_types.MinimumShouldMatch'
          query:
            type: string
        required:
        - query
    _types.query_dsl.RankFeatureFunctionSigmoid:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction'
      - type: object
        properties:
          pivot:
            description: Configurable pivot value so that the result will be less than 0.5.
            type: number
          exponent:
            description: Configurable Exponent.
            type: number
        required:
        - pivot
        - exponent
    _types.aggregations.GeoTileGridAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          field:
            description: 'Field containing indexed `geo_point` or `geo_shape` values.

              If the field contains an array, `geotile_grid` aggregates all array values.'
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          precision:
            description: 'Integer zoom of the key used to define cells/buckets in the results.

              Values outside of the range [0,29] will be rejected.'
            default: '7'
            allOf:
            - $ref: '#/components/schemas/_types.GeoTilePrecision'
          shard_size:
            description: '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.'
            type: number
          size:
            description: The maximum number of buckets to return.
            default: 10000.0
            type: number
          bounds:
            description: A bounding box to filter the geo-points or geo-shapes in each bucket.
            allOf:
            - $ref: '#/components/schemas/_types.GeoBounds'
    _types.aggregations.Aggregation:
      type: object
    _types.aggregations.AverageAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase'
      - type: object
    ml._types.QueryFeatureExtractor:
      type: object
      properties:
        default_score:
          type: number
        feature_name:
          type: string
        query:
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
      required:
      - feature_name
      - query
    ml._types.TrainedModelSizeStats:
      type: object
      properties:
        model_size_bytes:
          description: The size of the model in bytes.
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
        required_native_memory_bytes:
          description: The amount of memory required to load the model in bytes.
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
      required:
      - model_size_bytes
      - required_native_memory_bytes
    _types.query_dsl.FunctionScoreQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          boost_mode:
            description: "Defines how he newly computed score is combined with the score of the query\n\nSupported values include:\n  - `multiply`: Query score and function score are multiplied\n  - `replace`: Only the function score is used.\nThe query score is ignored.\n  - `sum`: Query score and function score are added\n  - `avg`: Query score and function score are averaged\n  - `max`: Max of query score and function score\n  - `min`: Min of query score and function score\n\n"
            default: multiply
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.FunctionBoostMode'
          functions:
            description: One or more functions that compute a new score for each document returned by the query.
            type: array
            items:
              $ref: '#/components/schemas/_types.query_dsl.FunctionScoreContainer'
          max_boost:
            description: Restricts the new score to not exceed the provided limit.
            type: number
          min_score:
            description: Excludes documents that do not meet the provided score threshold.
            type: number
          query:
            description: A query that determines the documents for which a new score is computed.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          score_mode:
            description: "Specifies how the computed scores are combined\n\nSupported values include:\n  - `multiply`: Scores are multiplied.\n  - `sum`: Scores are summed.\n  - `avg`: Scores are averaged.\n  - `first`: The first function that has a matching filter is applied.\n  - `max`: Maximum score is used.\n  - `min`: Minimum score is used.\n\n"
            default: multiply
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.FunctionScoreMode'
    _types.aggregations.MedianAbsoluteDeviationAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase'
      - type: object
        properties:
          compression:
            description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.
            default: 1000.0
            type: number
          execution_hint:
            description: 'The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).

              To use an implementation optimized for accuracy, set this parameter to high_accuracy instead.'
            default: default
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TDigestExecutionHint'
    _types.aggregations.MinimumInterval:
      type: string
      enum:
      - second
      - minute
      - hour
      - day
      - month
      - year
    _types.query_dsl.SimpleQueryStringFlag:
      type: string
      enum:
      - NONE
      - AND
      - NOT
      - OR
      - PREFIX
      - PHRASE
      - PRECEDENCE
      - ESCAPE
      - WHITESPACE
      - FUZZY
      - NEAR
      - SLOP
      - ALL
    _types.query_dsl.RangeQuery:
      externalDocs:
        url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query
      oneOf:
      - $ref: '#/components/schemas/_types.query_dsl.UntypedRangeQuery'
      - $ref: '#/components/schemas/_types.query_dsl.DateRangeQuery'
      - $ref: '#/components/schemas/_types.query_dsl.NumberRangeQuery'
      - $ref: '#/components/schemas/_types.query_dsl.TermRangeQuery'
    _types.aggregations.DateHistogramAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          calendar_interval:
            description: 'Calendar-aware interval.

              Can be specified using the unit name, such as `month`, or as a single unit quantity, such as `1M`.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CalendarInterval'
          extended_bounds:
            description: Enables extending the bounds of the histogram beyond the data itself.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath'
          hard_bounds:
            description: Limits the histogram to specified bounds.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsFieldDateMath'
          field:
            description: The date field whose values are use to build a histogram.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          fixed_interval:
            description: 'Fixed intervals: a fixed number of SI units and never deviate, regardless of where they fall on the calendar.'
            allOf:
            - $ref: '#/components/schemas/_types.Duration'
          format:
            description: '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.'
            type: string
          interval:
            deprecated: true
            allOf:
            - $ref: '#/components/schemas/_types.Duration'
          min_doc_count:
            description: '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.'
            type: number
          missing:
            description: 'The value to apply to documents that do not have a value.

              By default, documents without a value are ignored.'
            allOf:
            - $ref: '#/components/schemas/_types.DateTime'
          offset:
            description: Changes the start value of each bucket by the specified positive (`+`) or negative offset (`-`) duration.
            allOf:
            - $ref: '#/components/schemas/_types.Duration'
          order:
            description: The sort order of the returned buckets.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.AggregateOrder'
          params:
            type: object
            additionalProperties:
              type: object
          script:
            allOf:
            - $ref: '#/components/schemas/_types.Script'
          time_zone:
            description: 'Time zone used for bucketing and rounding.

              Defaults to Coordinated Universal Time (UTC).'
            allOf:
            - $ref: '#/components/schemas/_types.TimeZone'
          keyed:
            description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.
            type: boolean
    _types.aggregations.TermsExclude:
      oneOf:
      - type: string
      - type: array
        items:
          type: string
    _types.aggregations.CategorizeTextAnalyzer:
      oneOf:
      - type: string
      - $ref: '#/components/schemas/_types.aggregations.CustomCategorizeTextAnalyzer'
    _types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          origin:
            description: 'Date or point of origin used to calculate distances.

              If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.

              Date Math, such as `now-1h`, is supported.

              If the field value is a `geo_point` field, the `origin` value must be a geopoint.'
            allOf:
            - $ref: '#/components/schemas/_types.GeoLocation'
          pivot:
            description: 'Distance from the `origin` at which relevance scores receive half of the `boost` value.

              If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.'
            allOf:
            - $ref: '#/components/schemas/_types.Distance'
          field:
            description: 'Name of the field used to calculate distances. This field must meet the following criteria:

              be a `date`, `date_nanos` or `geo_point` field;

              have an `index` mapping parameter value of `true`, which is the default;

              have an `doc_values` mapping parameter value of `true`, which is the default.'
            allOf:
            - $ref: '#/components/schemas/_types.Field'
        required:
        - origin
        - pivot
        - field
    _types.aggregations.TopHitsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
        properties:
          docvalue_fields:
            description: Fields for which to return doc values.
            type: array
            items:
              $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat'
          explain:
            description: If `true`, returns detailed information about score computation as part of a hit.
            default: false
            type: boolean
          fields:
            description: 'Array of wildcard (*) patterns. The request returns values for field names

              matching these patterns in the hits.fields property of the response.'
            type: array
            items:
              $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat'
          from:
            description: Starting document offset.
            default: 0.0
            type: number
          highlight:
            description: Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in the search results.
            allOf:
            - $ref: '#/components/schemas/_global.search._types.Highlight'
          script_fields:
            description: Returns the result of one or more script evaluations for each hit.
            type: object
            additionalProperties:
              $ref: '#/components/schemas/_types.ScriptField'
          size:
            description: The maximum number of top matching hits to return per bucket.
            default: 3.0
            type: number
          sort:
            description: 'Sort order of the top matching hits.

              By default, the hits are sorted by the score of the main query.'
            allOf:
            - $ref: '#/components/schemas/_types.Sort'
          _source:
            description: Selects the fields of the source that are returned.
            allOf:
            - $ref: '#/components/schemas/_global.search._types.SourceConfig'
          stored_fields:
            description: Returns values for the specified stored fields (fields that use the `store` mapping option).
            allOf:
            - $ref: '#/components/schemas/_types.Fields'
          track_scores:
            description: If `true`, calculates and returns document scores, even if the scores are not used for sorting.
            default: false
            type: boolean
          version:
            description: If `true`, returns document version as part of a hit.
            default: false
            type: boolean
          seq_no_primary_term:
            description: If `true`, returns sequence number and primary term of the last modification of each hit.
            type: boolean
    _types.query_dsl.DecayFunctionBaseGeoLocationDistance:
      type: object
      properties:
        multi_value_mode:
          description: "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n  - `min`: Distance is the minimum distance.\n  - `max`: Distance is the maximum distance.\n  - `avg`: Distance is the average distance.\n  - `sum`: Distance is the sum of all distances.\n\n"
          default: min
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode'
    _types.ScriptField:
      type: object
      properties:
        script:
          allOf:
          - $ref: '#/components/schemas/_types.Script'
        ignore_failure:
          type: boolean
      required:
      - script
    _types.ScoreSort:
      type: object
      properties:
        order:
          description: "\n\nSupported values include:\n  - `asc`: Ascending (smallest to largest)\n  - `desc`: Descending (largest to smallest)\n\n"
          allOf:
          - $ref: '#/components/schemas/_types.SortOrder'
    _types.EpochTimeUnitMillis:
      allOf:
      - $ref: '#/components/schemas/_types.UnitMillis'
    _types.GeoDistanceSort:
      type: object
      properties:
        mode:
          allOf:
          - $ref: '#/components/schemas/_types.SortMode'
        distance_type:
          description: "\n\nSupported values include:\n  - `arc`: The `arc` calculation is the most accurate.\n  - `plane`: The `plane` calculation is faster but less accurate.\n\n"
          allOf:
          - $ref: '#/components/schemas/_types.GeoDistanceType'
        ignore_unmapped:
          type: boolean
        order:
          description: "\n\nSupported values include:\n  - `asc`: Ascending (smallest to largest)\n  - `desc`: Descending (largest to smallest)\n\n"
          allOf:
          - $ref: '#/components/schemas/_types.SortOrder'
        unit:
          allOf:
          - $ref: '#/components/schemas/_types.DistanceUnit'
        nested:
          allOf:
          - $ref: '#/components/schemas/_types.NestedSortValue'
    ml._types.NlpBertTokenizationConfig:
      description: BERT and MPNet tokenization configuration options
      allOf:
      - $ref: '#/components/schemas/ml._types.CommonTokenizationConfig'
      - type: object
    _types.aggregations.AggregationRange:
      type: object
      properties:
        from:
          description: Start of the range (inclusive).
          oneOf:
          - type: number
          - type:
            - string
            - 'null'
        key:
          description: Custom key to return the range with.
          type: string
        to:
          description: End of the range (exclusive).
          oneOf:
          - type: number
          - type:
            - string
            - 'null'
    _types.aggregations.InferenceAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          model_id:
            description: The ID or alias for the trained model.
            allOf:
            - $ref: '#/components/schemas/_types.Name'
          inference_config:
            description: Contains the inference type and its options.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.InferenceConfigContainer'
        required:
        - model_id
    _types.query_dsl.IntervalsContainer:
      type: object
      properties:
        all_of:
          description: Returns matches that span a combination of other rules.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsAllOf'
        any_of:
          description: Returns intervals produced by any of its sub-rules.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsAnyOf'
        fuzzy:
          description: Matches analyzed text.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsFuzzy'
        match:
          description: Matches analyzed text.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsMatch'
        prefix:
          description: Matches terms that start with a specified set of characters.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsPrefix'
        range:
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsRange'
        regexp:
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsRegexp'
        wildcard:
          description: Matches terms using a wildcard pattern.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsWildcard'
      minProperties: 1
      maxProperties: 1
    _types.query_dsl.FunctionScoreMode:
      type: string
      enum:
      - multiply
      - sum
      - avg
      - first
      - max
      - min
    _types.SpecifiedDocument:
      type: object
      properties:
        index:
          allOf:
          - $ref: '#/components/schemas/_types.IndexName'
        id:
          allOf:
          - $ref: '#/components/schemas/_types.Id'
      required:
      - id
    _types.query_dsl.RankFeatureQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          field:
            description: '`rank_feature` or `rank_features` field used to boost relevance scores.'
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          saturation:
            description: Saturation function used to boost relevance scores based on the value of the rank feature `field`.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionSaturation'
          log:
            description: Logarithmic function used to boost relevance scores based on the value of the rank feature `field`.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionLogarithm'
          linear:
            description: Linear function used to boost relevance scores based on the value of the rank feature `field`.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionLinear'
          sigmoid:
            description: Sigmoid function used to boost relevance scores based on the value of the rank feature `field`.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunctionSigmoid'
        required:
        - field
    ml._types.TextEmbeddingInferenceUpdateOptions:
      type: object
      properties:
        tokenization:
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpTokenizationUpdateOptions'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
    _types.aggregations.GeoBoundsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
        properties:
          wrap_longitude:
            description: Specifies whether the bounding box should be allowed to overlap the international date line.
            default: true
            type: boolean
    _types.query_dsl.ScriptQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          script:
            description: 'Contains a script to run as a query.

              This script must return a boolean value, `true` or `false`.'
            allOf:
            - $ref: '#/components/schemas/_types.Script'
        required:
        - script
    ml._types.TextExpansionInferenceOptions:
      description: Text expansion inference options
      type: object
      properties:
        tokenization:
          description: The tokenization options
          allOf:
          - $ref: '#/components/schemas/ml._types.TokenizationConfigContainer'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        vocabulary:
          allOf:
          - $ref: '#/components/schemas/ml._types.Vocabulary'
    _types.query_dsl.FieldValueFactorScoreFunction:
      type: object
      properties:
        field:
          description: Field to be extracted from the document.
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        factor:
          description: Optional factor to multiply the field value with.
          default: 1.0
          type: number
        missing:
          description: 'Value used if the document doesn’t have that field.

            The modifier and factor are still applied to it as though it were read from the document.'
          type: number
        modifier:
          description: "Modifier to apply to the field value.\n\nSupported values include:\n  - `none`: Do not apply any multiplier to the field value.\n  - `log`: Take the common logarithm of the field value.\nBecause this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `log1p` instead.\n  - `log1p`: Add 1 to the field value and take the common logarithm.\n  - `log2p`: Add 2 to the field value and take the common logarithm.\n  - `ln`: Take the natural logarithm of the field value.\nBecause this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to use `ln1p` instead.\n  - `ln1p`: Add 1 to the field value and take the natural logarithm.\n  - `ln2p`: Add 2 to the field value and take the natural logarithm.\n  - `square`: Square the field value (multiply it by itself).\n  - `sqrt`: Take the square root of the field value.\n  - `reciprocal`: Reciprocate the field value, same as `1/x` where `x` is the field’s value.\n\n"
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.FieldValueFactorModifier'
      required:
      - field
    _types.aggregations.MultiTermsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          collect_mode:
            description: "Specifies the strategy for data collection.\n\nSupported values include:\n  - `depth_first`: Expands all branches of the aggregation tree in one depth-first pass, before any pruning occurs.\n  - `breadth_first`: Caches the set of documents that fall into the uppermost buckets for subsequent replay.\n\n"
            default: breadth_first
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsAggregationCollectMode'
          order:
            description: 'Specifies the sort order of the buckets.

              Defaults to sorting by descending document count.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.AggregateOrder'
          min_doc_count:
            description: The minimum number of documents in a bucket for it to be returned.
            default: 1.0
            type: number
          shard_min_doc_count:
            description: The minimum number of documents in a bucket on each shard for it to be returned.
            default: 1.0
            type: number
          shard_size:
            description: '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.'
            type: number
          show_term_doc_count_error:
            description: Calculates the doc count error on per term basis.
            default: false
            type: boolean
          size:
            description: The number of term buckets should be returned out of the overall terms list.
            default: 10.0
            type: number
          terms:
            description: The field from which to generate sets of terms.
            type: array
            items:
              $ref: '#/components/schemas/_types.aggregations.MultiTermLookup'
        required:
        - terms
    _types.TimeZone:
      type: string
    _types.aggregations.ReverseNestedAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          path:
            description: 'Defines the nested object field that should be joined back to.

              The default is empty, which means that it joins back to the root/main document level.'
            allOf:
            - $ref: '#/components/schemas/_types.Field'
    _types.query_dsl.DistanceFeatureQuery:
      externalDocs:
        url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query
      oneOf:
      - $ref: '#/components/schemas/_types.query_dsl.UntypedDistanceFeatureQuery'
      - $ref: '#/components/schemas/_types.query_dsl.GeoDistanceFeatureQuery'
      - $ref: '#/components/schemas/_types.query_dsl.DateDistanceFeatureQuery'
    _types.aggregations.MovingPercentilesAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          window:
            description: The size of window to "slide" across the histogram.
            type: number
          shift:
            description: 'By default, the window consists of the last n values excluding the current bucket.

              Increasing `shift` by 1, moves the starting window position by 1 to the right.'
            default: 0.0
            type: number
          keyed:
            type: boolean
    _types.aggregations.CompositeAggregationBase:
      type: object
      properties:
        field:
          description: Either `field` or `script` must be present
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        missing_bucket:
          type: boolean
        missing_order:
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.MissingOrder'
        script:
          description: Either `field` or `script` must be present
          allOf:
          - $ref: '#/components/schemas/_types.Script'
        value_type:
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.ValueType'
        order:
          description: "\n\nSupported values include:\n  - `asc`: Ascending (smallest to largest)\n  - `desc`: Descending (largest to smallest)\n\n"
          allOf:
          - $ref: '#/components/schemas/_types.SortOrder'
    _types.aggregations.SerialDifferencingAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          lag:
            description: 'The historical bucket to subtract from the current value.

              Must be a positive, non-zero integer.'
            type: number
    _types.mapping.RuntimeFields:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/_types.mapping.RuntimeField'
    _types.aggregations.NestedAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          path:
            description: The path to the field of type `nested`.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
    _types.query_dsl.QueryContainer:
      externalDocs:
        url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl
      description: An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
      type: object
      properties:
        bool:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-bool-query
          description: matches documents matching boolean combinations of other queries.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.BoolQuery'
        boosting:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-boosting-query
          description: Returns documents matching a `positive` query while reducing the relevance score of documents that also match a `negative` query.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.BoostingQuery'
        common:
          deprecated: true
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.CommonTermsQuery'
          minProperties: 1
          maxProperties: 1
        combined_fields:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-combined-fields-query
          description: The `combined_fields` query supports searching multiple text fields as if their contents had been indexed into one combined field.
          x-state: Generally available; Added in 7.13.0
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.CombinedFieldsQuery'
        constant_score:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-constant-score-query
          description: Wraps a filter query and returns every matching document with a relevance score equal to the `boost` parameter value.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.ConstantScoreQuery'
        dis_max:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-dis-max-query
          description: 'Returns documents matching one or more wrapped queries, called query clauses or clauses.

            If a returned document matches multiple query clauses, the `dis_max` query assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries.'
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.DisMaxQuery'
        distance_feature:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-distance-feature-query
          description: 'Boosts the relevance score of documents closer to a provided origin date or point.

            For example, you can use this query to give more weight to documents closer to a certain date or location.'
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQuery'
        exists:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-exists-query
          description: Returns documents that contain an indexed value for a field.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.ExistsQuery'
        function_score:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-function-score-query
          description: The `function_score` enables you to modify the score of documents that are retrieved by a query.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.FunctionScoreQuery'
        fuzzy:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-fuzzy-query
          description: Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.FuzzyQuery'
          minProperties: 1
          maxProperties: 1
        geo_bounding_box:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-bounding-box-query
          description: Matches geo_point and geo_shape values that intersect a bounding box.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.GeoBoundingBoxQuery'
        geo_distance:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-distance-query
          description: Matches `geo_point` and `geo_shape` values within a given distance of a geopoint.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.GeoDistanceQuery'
        geo_grid:
          description: Matches `geo_point` and `geo_shape` values that intersect a grid cell from a GeoGrid aggregation.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.GeoGridQuery'
          minProperties: 1
          maxProperties: 1
        geo_polygon:
          deprecated: true
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.GeoPolygonQuery'
        geo_shape:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-geo-shape-query
          description: Filter documents indexed using either the `geo_shape` or the `geo_point` type.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.GeoShapeQuery'
        has_child:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-child-query
          description: Returns parent documents whose joined child documents match a provided query.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.HasChildQuery'
        has_parent:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-has-parent-query
          description: Returns child documents whose joined parent document matches a provided query.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.HasParentQuery'
        ids:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-ids-query
          description: 'Returns documents based on their IDs.

            This query uses document IDs stored in the `_id` field.'
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IdsQuery'
        intervals:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query
          description: Returns documents based on the order and proximity of matching terms.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.IntervalsQuery'
          minProperties: 1
          maxProperties: 1
        knn:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-knn-query
          description: 'Finds the k nearest vectors to a query vector, as measured by a similarity

            metric. knn query finds nearest vectors through approximate search on indexed

            dense_vectors.'
          allOf:
          - $ref: '#/components/schemas/_types.KnnQuery'
        match:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query
          description: 'Returns documents that match a provided text, number, date or boolean value.

            The provided text is analyzed before matching.'
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.MatchQuery'
          minProperties: 1
          maxProperties: 1
        match_all:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query
          description: Matches all documents, giving them all a `_score` of 1.0.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.MatchAllQuery'
        match_bool_prefix:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-bool-prefix-query
          description: '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.'
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.MatchBoolPrefixQuery'
          minProperties: 1
          maxProperties: 1
        match_none:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-all-query#query-dsl-match-none-query
          description: Matches no documents.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.MatchNoneQuery'
        match_phrase:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase
          description: Analyzes the text and creates a phrase query out of the analyzed text.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.MatchPhraseQuery'
          minProperties: 1
          maxProperties: 1
        match_phrase_prefix:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-match-query-phrase-prefix
          description: '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.'
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.MatchPhrasePrefixQuery'
          minProperties: 1
          maxProperties: 1
        more_like_this:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-mlt-query
          description: Returns documents that are "like" a given set of documents.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.MoreLikeThisQuery'
        multi_match:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-multi-match-query
          description: 'Enables you to search for a provided text, number, date or boolean value across multiple fields.

            The provided text is analyzed before matching.'
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.MultiMatchQuery'
        nested:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-nested-query
          description: 'Wraps another query to search nested fields.

            If an object matches the search, the nested query returns the root parent document.'
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.NestedQuery'
        parent_id:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-parent-id-query
          description: Returns child documents joined to a specific parent document.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.ParentIdQuery'
        percolate:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-percolate-query
          description: Matches queries stored in an index.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.PercolateQuery'
        pinned:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query
          description: Promotes selected documents to rank higher than those matching a given query.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.PinnedQuery'
        prefix:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-prefix-query
          description: Returns documents that contain a specific prefix in a provided field.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.PrefixQuery'
          minProperties: 1
          maxProperties: 1
        query_string:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-query-string-query
          description: Returns documents based on a provided query string, using a parser with a strict syntax.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.QueryStringQuery'
        range:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-range-query
          description: Returns documents that contain terms within a provided range.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.RangeQuery'
          minProperties: 1
          maxProperties: 1
        rank_feature:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-rank-feature-query
          description: Boosts the relevance score of documents based on the numeric value of a `rank_feature` or `rank_features` field.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.RankFeatureQuery'
        regexp:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-regexp-query
          description: Returns documents that contain terms matching a regular expression.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.RegexpQuery'
          minProperties: 1
          maxProperties: 1
        rule:
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.RuleQuery'
        script:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-query
          description: 'Filters documents based on a provided script.

            The script query is typically used in a filter context.'
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.ScriptQuery'
        script_score:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-script-score-query
          description: Uses a script to provide a custom score for returned documents.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.ScriptScoreQuery'
        semantic:
          description: A semantic query to semantic_text field types
          x-state: Generally available; Added in 8.15.0
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SemanticQuery'
        shape:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-shape-query
          description: Queries documents that contain fields indexed using the `shape` type.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.ShapeQuery'
        simple_query_string:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-simple-query-string-query
          description: Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SimpleQueryStringQuery'
        span_containing:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-containing-query
          description: Returns matches which enclose another span query.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanContainingQuery'
        span_field_masking:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-field-masking-query
          description: Wrapper to allow span queries to participate in composite single-field span queries by _lying_ about their search field.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanFieldMaskingQuery'
        span_first:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-first-query
          description: Matches spans near the beginning of a field.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanFirstQuery'
        span_multi:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-multi-term-query
          description: Allows you to wrap a multi term query (one of `wildcard`, `fuzzy`, `prefix`, `range`, or `regexp` query) as a `span` query, so it can be nested.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanMultiTermQuery'
        span_near:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-near-query
          description: 'Matches spans which are near one another.

            You can specify `slop`, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.'
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanNearQuery'
        span_not:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-not-query
          description: Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter `pre`) or y tokens after (controlled by the parameter `post`) another span query.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanNotQuery'
        span_or:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-query
          description: Matches the union of its span clauses.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanOrQuery'
        span_term:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-term-query
          description: Matches spans containing a term.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.SpanTermQuery'
          minProperties: 1
          maxProperties: 1
        span_within:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-span-within-query
          description: Returns matches which are enclosed inside another span query.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SpanWithinQuery'
        sparse_vector:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-sparse-vector-query
          description: Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field.
          x-state: Generally available; Added in 8.15.0
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.SparseVectorQuery'
        term:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-term-query
          description: '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.'
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.TermQuery'
          minProperties: 1
          maxProperties: 1
        terms:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-query
          description: 'Returns documents that contain one or more exact terms in a provided field.

            To return a document, one or more terms must exactly match a field value, including whitespace and capitalization.'
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.TermsQuery'
        terms_set:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-terms-set-query
          description: '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.'
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.TermsSetQuery'
          minProperties: 1
          maxProperties: 1
        text_expansion:
          deprecated: true
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-text-expansion-query
          description: 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.
          x-state: Generally available; Added in 8.8.0
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.TextExpansionQuery'
          minProperties: 1
          maxProperties: 1
        weighted_tokens:
          deprecated: true
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-weighted-tokens-query
          description: Supports returning text_expansion query results by sending in precomputed tokens with the query.
          x-state: Generally available; Added in 8.13.0
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.WeightedTokensQuery'
          minProperties: 1
          maxProperties: 1
        wildcard:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wildcard-query
          description: Returns documents that contain terms matching a wildcard pattern.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.query_dsl.WildcardQuery'
          minProperties: 1
          maxProperties: 1
        wrapper:
          externalDocs:
            url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-wrapper-query
          description: A query that accepts any other query as base64 encoded string.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.WrapperQuery'
        type:
          deprecated: true
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.TypeQuery'
      minProperties: 1
      maxProperties: 1
    _types.KnnQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          field:
            description: The name of the vector field to search against
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          query_vector:
            description: The query vector
            allOf:
            - $ref: '#/components/schemas/_types.QueryVector'
          query_vector_builder:
            description: The query vector builder. You must provide a query_vector_builder or query_vector, but not both.
            allOf:
            - $ref: '#/components/schemas/_types.QueryVectorBuilder'
          num_candidates:
            description: The number of nearest neighbor candidates to consider per shard
            type: number
          visit_percentage:
            description: The percentage of vectors to explore per shard while doing knn search with bbq_disk
            x-state: Generally available; Added in 9.2.0
            type: number
          k:
            description: The final number of nearest neighbors to return as top hits
            type: number
          filter:
            description: Filters for the kNN search query
            oneOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
            - type: array
              items:
                $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          similarity:
            description: The minimum similarity for a vector to be considered a match
            type: number
          rescore_vector:
            description: Apply oversampling and rescoring to quantized vectors
            x-state: Generally available; Added in 8.18.0
            allOf:
            - $ref: '#/components/schemas/_types.RescoreVector'
        required:
        - field
    _types.SortResults:
      type: array
      items:
        $ref: '#/components/schemas/_types.FieldValue'
    _types.aggregations.BucketAggregationBase:
      description: Base type for bucket aggregations. These aggregations also accept sub-aggregations.
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.Aggregation'
      - type: object
    ml._types.TokenizationTruncate:
      type: string
      enum:
      - first
      - second
      - none
    ml._types.TrainedModelInferenceClassImportance:
      type: object
      properties:
        class_name:
          type: string
        importance:
          type: number
      required:
      - class_name
      - importance
    ml._types.TrainedModelDeploymentAllocationStatus:
      type: object
      properties:
        allocation_count:
          description: The current number of nodes where the model is allocated.
          type: number
        state:
          description: "The detailed allocation state related to the nodes.\n\nSupported values include:\n  - `started`: The trained model is started on at least one node.\n  - `starting`: Trained model deployment is starting but it is not yet deployed on any nodes.\n  - `fully_allocated`: Trained model deployment has started on all valid nodes.\n\n"
          allOf:
          - $ref: '#/components/schemas/ml._types.DeploymentAllocationState'
        target_allocation_count:
          description: The desired number of nodes for model allocation.
          type: number
      required:
      - allocation_count
      - state
      - target_allocation_count
    _global.search._types.HighlighterOrder:
      type: string
      enum:
      - score
    ml._types.FillMaskInferenceOptions:
      description: Fill mask inference options
      type: object
      properties:
        mask_token:
          description: 'The string/token which will be removed from incoming documents and replaced with the inference prediction(s).

            In a response, this field contains the mask token for the specified model/tokenizer. Each model and tokenizer

            has a predefined mask token which cannot be changed. Thus, it is recommended not to set this value in requests.

            However, if this field is present in a request, its value must match the predefined value for that model/tokenizer,

            otherwise the request will fail.'
          type: string
        num_top_classes:
          description: Specifies the number of top class predictions to return. Defaults to 0.
          type: number
        tokenization:
          description: The tokenization options to update when inferring
          allOf:
          - $ref: '#/components/schemas/ml._types.TokenizationConfigContainer'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        vocabulary:
          allOf:
          - $ref: '#/components/schemas/ml._types.Vocabulary'
    _types.query_dsl.CombinedFieldsOperator:
      type: string
      enum:
      - or
      - and
    _types.aggregations.IpRangeAggregationRange:
      type: object
      properties:
        from:
          description: Start of the range.
          oneOf:
          - type: string
          - type:
            - string
            - 'null'
        mask:
          description: IP range defined as a CIDR mask.
          type: string
        to:
          description: End of the range.
          oneOf:
          - type: string
          - type:
            - string
            - 'null'
    ml._types.TrainedModelLocationIndex:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/_types.IndexName'
      required:
      - name
    ml._types.TrainedModelDeploymentStats:
      type: object
      properties:
        adaptive_allocations:
          allOf:
          - $ref: '#/components/schemas/ml._types.AdaptiveAllocationsSettings'
        allocation_status:
          description: The detailed allocation status for the deployment.
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelDeploymentAllocationStatus'
        cache_size:
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
        deployment_id:
          description: The unique identifier for the trained model deployment.
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        error_count:
          description: The sum of `error_count` for all nodes in the deployment.
          type: number
        inference_count:
          description: The sum of `inference_count` for all nodes in the deployment.
          type: number
        model_id:
          description: The unique identifier for the trained model.
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        nodes:
          description: 'The deployment stats for each node that currently has the model allocated.

            In serverless, stats are reported for a single unnamed virtual node.'
          type: array
          items:
            $ref: '#/components/schemas/ml._types.TrainedModelDeploymentNodesStats'
        number_of_allocations:
          description: The number of allocations requested.
          type: number
        peak_throughput_per_minute:
          type: number
        priority:
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainingPriority'
        queue_capacity:
          description: The number of inference requests that can be queued before new requests are rejected.
          type: number
        rejected_execution_count:
          description: 'The sum of `rejected_execution_count` for all nodes in the deployment.

            Individual nodes reject an inference request if the inference queue is full.

            The queue size is controlled by the `queue_capacity` setting in the start

            trained model deployment API.'
          type: number
        reason:
          description: 'The reason for the current deployment state. Usually only populated when

            the model is not deployed to a node.'
          type: string
        start_time:
          description: The epoch timestamp when the deployment started.
          allOf:
          - $ref: '#/components/schemas/_types.EpochTimeUnitMillis'
        state:
          description: "The overall state of the deployment.\n\nSupported values include:\n  - `started`: The deployment is usable; at least one node has the model allocated.\n  - `starting`: The deployment has recently started but is not yet usable; the model is not allocated on any nodes.\n  - `stopping`: The deployment is preparing to stop and deallocate the model from the relevant nodes.\n  - `failed`: The deployment is on a failed state and must be re-deployed.\n\n"
          allOf:
          - $ref: '#/components/schemas/ml._types.DeploymentAssignmentState'
        threads_per_allocation:
          description: The number of threads used be each allocation during inference.
          type: number
        timeout_count:
          description: The sum of `timeout_count` for all nodes in the deployment.
          type: number
      required:
      - deployment_id
      - model_id
      - nodes
      - peak_throughput_per_minute
      - priority
      - start_time
    _types.query_dsl.RankFeatureFunctionLogarithm:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction'
      - type: object
        properties:
          scaling_factor:
            description: Configurable scaling factor.
            type: number
        required:
        - scaling_factor
    ml.put_trained_model.OneHotEncodingPreprocessor:
      type: object
      properties:
        field:
          type: string
        hot_map:
          type: object
          additionalProperties:
            type: string
      required:
      - field
      - hot_map
    _types.aggregations.TermsAggregationExecutionHint:
      type: string
      enum:
      - map
      - global_ordinals
      - global_ordinals_hash
      - global_ordinals_low_cardinality
    _types.query_dsl.RangeQueryBaseDateMath:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          relation:
            description: "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n  - `within`: Matches documents with a range field value entirely within the query’s range.\n  - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n  - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n"
            default: intersects
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.RangeRelation'
          gt:
            description: Greater than.
            allOf:
            - $ref: '#/components/schemas/_types.DateMath'
          gte:
            description: Greater than or equal to.
            allOf:
            - $ref: '#/components/schemas/_types.DateMath'
          lt:
            description: Less than.
            allOf:
            - $ref: '#/components/schemas/_types.DateMath'
          lte:
            description: Less than or equal to.
            allOf:
            - $ref: '#/components/schemas/_types.DateMath'
    _types.aggregations.BoxplotAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
        properties:
          compression:
            description: Limits the maximum number of nodes used by the underlying TDigest algorithm to `20 * compression`, enabling control of memory usage and approximation error.
            type: number
          execution_hint:
            description: 'The default implementation of TDigest is optimized for performance, scaling to millions or even billions of sample values while maintaining acceptable accuracy levels (close to 1% relative error for millions of samples in some cases).

              To use an implementation optimized for accuracy, set this parameter to high_accuracy instead.'
            default: default
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TDigestExecutionHint'
    _types.aggregations.ValueType:
      type: string
      enum:
      - string
      - long
      - double
      - number
      - date
      - date_nanos
      - ip
      - numeric
      - geo_point
      - boolean
    _global.search._types.BoundaryScanner:
      type: string
      enum:
      - chars
      - sentence
      - word
    _types.query_dsl.PinnedQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - externalDocs:
          url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-pinned-query
        allOf:
        - type: object
          properties:
            organic:
              description: Any choice of query used to rank documents which will be ranked below the "pinned" documents.
              allOf:
              - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          required:
          - organic
        - type: object
          properties:
            ids:
              description: 'Document IDs listed in the order they are to appear in results.

                Required if `docs` is not specified.'
              type: array
              items:
                $ref: '#/components/schemas/_types.Id'
            docs:
              description: 'Documents listed in the order they are to appear in results.

                Required if `ids` is not specified.'
              type: array
              items:
                $ref: '#/components/schemas/_types.query_dsl.PinnedDoc'
          minProperties: 1
          maxProperties: 1
    _types.aggregations.DateRangeExpression:
      type: object
      properties:
        from:
          description: Start of the range (inclusive).
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.FieldDateMath'
        key:
          description: Custom key to return the range with.
          type: string
        to:
          description: End of the range (exclusive).
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.FieldDateMath'
    _types.aggregations.TermsAggregationCollectMode:
      type: string
      enum:
      - depth_first
      - breadth_first
    _types.aggregations.BucketCorrelationFunction:
      type: object
      properties:
        count_correlation:
          description: The configuration to calculate a count correlation. This function is designed for determining the correlation of a term value and a given metric.
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelation'
      required:
      - count_correlation
    _types.query_dsl.IntervalsAnyOf:
      type: object
      properties:
        intervals:
          description: An array of rules to match.
          type: array
          items:
            $ref: '#/components/schemas/_types.query_dsl.IntervalsContainer'
        filter:
          description: Rule used to filter returned intervals.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsFilter'
      required:
      - intervals
    _types.aggregations.BucketSelectorAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          script:
            description: The script to run for this aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.Script'
    _types.UnitMillis:
      description: Time unit for milliseconds
      type: number
    ml._types.LearningToRankConfig:
      type: object
      properties:
        default_params:
          type: object
          additionalProperties:
            type: object
        feature_extractors:
          type: array
          items:
            type: object
            additionalProperties:
              $ref: '#/components/schemas/ml._types.FeatureExtractor'
        num_top_feature_importance_values:
          type: number
      required:
      - num_top_feature_importance_values
    ml._types.Include:
      type: string
      enum:
      - definition
      - feature_importance_baseline
      - hyperparameters
      - total_feature_importance
      - definition_status
    _types.ChunkRescorer:
      type: object
      properties:
        size:
          description: The number of chunks per document to evaluate for reranking.
          type: number
        chunking_settings:
          description: Chunking settings to apply
          allOf:
          - $ref: '#/components/schemas/_types.mapping.ChunkRescorerChunkingSettings'
    ml._types.ZeroShotClassificationInferenceOptions:
      description: Zero shot classification configuration options
      type: object
      properties:
        tokenization:
          description: The tokenization options to update when inferring
          allOf:
          - $ref: '#/components/schemas/ml._types.TokenizationConfigContainer'
        hypothesis_template:
          description: Hypothesis template used when tokenizing labels for prediction
          default: '"This example is {}."'
          type: string
        classification_labels:
          description: 'The zero shot classification labels indicating entailment, neutral, and contradiction

            Must contain exactly and only entailment, neutral, and contradiction'
          type: array
          items:
            type: string
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        multi_label:
          description: Indicates if more than one true label exists.
          default: false
          type: boolean
        labels:
          description: The labels to predict.
          type: array
          items:
            type: string
      required:
      - classification_labels
    _types.query_dsl.RandomScoreFunction:
      type: object
      properties:
        field:
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        seed:
          oneOf:
          - type: number
          - type: string
    _types.RRFRetrieverComponent:
      description: Wraps a retriever with an optional weight for RRF scoring.
      type: object
      properties:
        retriever:
          description: The nested retriever configuration.
          allOf:
          - $ref: '#/components/schemas/_types.RetrieverContainer'
        weight:
          description: Weight multiplier for this retriever's contribution to the RRF score. Higher values increase influence. Defaults to 1.0 if not specified. Must be non-negative.
          default: 1.0
          type: number
      required:
      - retriever
    _types.query_dsl.PinnedDoc:
      type: object
      properties:
        _id:
          description: The unique document ID.
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        _index:
          description: The index that contains the document.
          allOf:
          - $ref: '#/components/schemas/_types.IndexName'
      required:
      - _id
    _types.aggregations.DerivativeAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
    ml._types.RegressionInferenceOptions:
      type: object
      properties:
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        num_top_feature_importance_values:
          description: Specifies the maximum number of feature importance values per document.
          default: 0.0
          type: number
    _types.DiversifyRetriever:
      allOf:
      - $ref: '#/components/schemas/_types.RetrieverBase'
      - type: object
        properties:
          type:
            description: The diversification strategy to apply.
            allOf:
            - $ref: '#/components/schemas/_types.DiversifyRetrieverTypes'
          field:
            description: The document field on which to diversify results on.
            type: string
          retriever:
            description: The nested retriever whose results will be diversified.
            allOf:
            - $ref: '#/components/schemas/_types.RetrieverContainer'
          size:
            description: The number of top documents to return after diversification.
            type: number
          rank_window_size:
            description: The number of top documents from the nested retriever to consider for diversification.
            type: number
          query_vector:
            description: The query vector used for diversification.
            allOf:
            - $ref: '#/components/schemas/_types.QueryVector'
          query_vector_builder:
            description: a dense vector query vector builder to use instead of a static query_vector
            allOf:
            - $ref: '#/components/schemas/_types.QueryVectorBuilder'
          lambda:
            description: Controls the trade-off between relevance and diversity for MMR. A value of 0.0 focuses solely on diversity, while a value of 1.0 focuses solely on relevance. Required for MMR
            type: number
        required:
        - type
        - field
        - retriever
    _types.query_dsl.RankFeatureFunctionSaturation:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction'
      - type: object
        properties:
          pivot:
            description: Configurable pivot value so that the result will be less than 0.5.
            type: number
    _global.search._types.HighlighterTagsSchema:
      type: string
      enum:
      - styled
    _types.query_dsl.DecayFunctionBase:
      type: object
      properties:
        multi_value_mode:
          description: "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n  - `min`: Distance is the minimum distance.\n  - `max`: Distance is the maximum distance.\n  - `avg`: Distance is the average distance.\n  - `sum`: Distance is the sum of all distances.\n\n"
          default: min
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode'
    _types.RuleRetriever:
      allOf:
      - $ref: '#/components/schemas/_types.RetrieverBase'
      - type: object
        properties:
          ruleset_ids:
            description: The ruleset IDs containing the rules this retriever is evaluating against.
            oneOf:
            - $ref: '#/components/schemas/_types.Id'
            - type: array
              items:
                $ref: '#/components/schemas/_types.Id'
          match_criteria:
            description: The match criteria that will determine if a rule in the provided rulesets should be applied.
            type: object
          retriever:
            description: The retriever whose results rules should be applied to.
            allOf:
            - $ref: '#/components/schemas/_types.RetrieverContainer'
          rank_window_size:
            description: This value determines the size of the individual result set.
            type: number
        required:
        - ruleset_ids
        - match_criteria
        - retriever
    _types.aggregations.Missing:
      oneOf:
      - type: string
      - type: number
      - type: number
      - type: boolean
    _types.aggregations.BucketCorrelationFunctionCountCorrelation:
      type: object
      properties:
        indicator:
          description: The indicator with which to correlate the configured `bucket_path` values.
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationFunctionCountCorrelationIndicator'
      required:
      - indicator
    _spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag:
      description: 'A set of flags that can be represented as a single enum value or a set of values that are encoded

        as a pipe-separated string


        Depending on the target language, code generators can use this hint to generate language specific

        flags enum constructs and the corresponding (de-)serialization code.'
      oneOf:
      - $ref: '#/components/schemas/_types.query_dsl.SimpleQueryStringFlag'
      - type: string
    _types.aggregations.FieldDateMath:
      description: 'A date range limit, represented either as a DateMath expression or a number expressed

        according to the target field''s precision.'
      oneOf:
      - $ref: '#/components/schemas/_types.DateMath'
      - type: number
    _types.query_dsl.SpanContainingQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          big:
            description: 'Can be any span query.

              Matching spans from `big` that contain matches from `little` are returned.'
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
          little:
            description: 'Can be any span query.

              Matching spans from `big` that contain matches from `little` are returned.'
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
        required:
        - big
        - little
    ml._types.XlmRobertaTokenizationConfig:
      allOf:
      - $ref: '#/components/schemas/ml._types.CommonTokenizationConfig'
      - type: object
    _types.query_dsl.FuzzyQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          max_expansions:
            description: Maximum number of variations created.
            default: 50.0
            type: number
          prefix_length:
            description: Number of beginning characters left unchanged when creating expansions.
            default: 0.0
            type: number
          rewrite:
            description: Number of beginning characters left unchanged when creating expansions.
            default: constant_score
            allOf:
            - $ref: '#/components/schemas/_types.MultiTermQueryRewrite'
          transpositions:
            description: Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`).
            default: true
            type: boolean
          fuzziness:
            description: Maximum edit distance allowed for matching.
            allOf:
            - $ref: '#/components/schemas/_types.Fuzziness'
          value:
            description: Term you wish to find in the provided field.
            oneOf:
            - type: string
            - type: number
            - type: boolean
        required:
        - value
    _global.search._types.RescoreQuery:
      type: object
      properties:
        rescore_query:
          description: 'The query to use for rescoring.

            This query is only run on the Top-K results returned by the `query` and `post_filter` phases.'
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
        query_weight:
          description: Relative importance of the original query versus the rescore query.
          default: 1.0
          type: number
        rescore_query_weight:
          description: Relative importance of the rescore query versus the original query.
          default: 1.0
          type: number
        score_mode:
          description: "Determines how scores are combined.\n\nSupported values include:\n  - `avg`: Average the original score and the rescore query score.\n  - `max`: Take the max of original score and the rescore query score.\n  - `min`: Take the min of the original score and the rescore query score.\n  - `multiply`: Multiply the original score by the rescore query score.\nUseful for `function` query rescores.\n  - `total`: Add the original score and the rescore query score.\n\n"
          default: total
          allOf:
          - $ref: '#/components/schemas/_global.search._types.ScoreMode'
      required:
      - rescore_query
    ml._types.TopClassEntry:
      type: object
      properties:
        class_name:
          type: string
        class_probability:
          type: number
        class_score:
          type: number
      required:
      - class_name
      - class_probability
      - class_score
    _types.aggregations.TopMetricsValue:
      type: object
      properties:
        field:
          description: A field to return as a metric.
          allOf:
          - $ref: '#/components/schemas/_types.Field'
      required:
      - field
    _types.aggregations.StringStatsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
        properties:
          show_distribution:
            description: Shows the probability distribution for all characters.
            default: false
            type: boolean
    _types.aggregations.CompositeTermsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase'
      - type: object
    _types.query_dsl.SpanNearQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          clauses:
            description: Array of one or more other span type queries.
            type: array
            items:
              $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
          in_order:
            description: Controls whether matches are required to be in-order.
            type: boolean
          slop:
            description: Controls the maximum number of intervening unmatched positions permitted.
            type: number
        required:
        - clauses
    _types.RrfRank:
      allOf:
      - $ref: '#/components/schemas/_types.RankBase'
      - type: object
        properties:
          rank_constant:
            description: How much influence documents in individual result sets per query have over the final ranked result set
            type: number
          rank_window_size:
            description: Size of the individual result sets per query
            type: number
    ml._types.TrainedModelAssignmentRoutingStateAndReason:
      type: object
      properties:
        reason:
          description: 'The reason for the current state. It is usually populated only when the

            `routing_state` is `failed`.'
          type: string
        routing_state:
          description: "The current routing state.\n\nSupported values include:\n  - `failed`: The allocation attempt failed.\n  - `started`: The trained model is allocated and ready to accept inference requests.\n  - `starting`: The trained model is attempting to allocate on this node; inference requests are not yet accepted.\n  - `stopped`: The trained model is fully deallocated from this node.\n  - `stopping`: The trained model is being deallocated from this node.\n\n"
          allOf:
          - $ref: '#/components/schemas/ml._types.RoutingState'
      required:
      - routing_state
    _types.aggregations.GeoLinePoint:
      type: object
      properties:
        field:
          description: The name of the geo_point field.
          allOf:
          - $ref: '#/components/schemas/_types.Field'
      required:
      - field
    _types.query_dsl.ScriptScoreQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          min_score:
            description: Documents with a score lower than this floating point number are excluded from the search results.
            type: number
          query:
            description: Query used to return documents.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          script:
            description: 'Script used to compute the score of documents returned by the query.

              Important: final relevance scores from the `script_score` query cannot be negative.'
            allOf:
            - $ref: '#/components/schemas/_types.Script'
        required:
        - query
        - script
    ml.put_trained_model.TrainedModel:
      type: object
      properties:
        tree:
          description: The definition for a binary decision tree.
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.TrainedModelTree'
        tree_node:
          description: 'The definition of a node in a tree.

            There are two major types of nodes: leaf nodes and not-leaf nodes.

            - Leaf nodes only need node_index and leaf_value defined.

            - All other nodes need split_feature, left_child, right_child, threshold, decision_type, and default_left defined.'
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.TrainedModelTreeNode'
        ensemble:
          description: The definition for an ensemble model
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.Ensemble'
    _types.analysis.StopWordLanguage:
      type: string
      enum:
      - _arabic_
      - _armenian_
      - _basque_
      - _bengali_
      - _brazilian_
      - _bulgarian_
      - _catalan_
      - _cjk_
      - _czech_
      - _danish_
      - _dutch_
      - _english_
      - _estonian_
      - _finnish_
      - _french_
      - _galician_
      - _german_
      - _greek_
      - _hindi_
      - _hungarian_
      - _indonesian_
      - _irish_
      - _italian_
      - _latvian_
      - _lithuanian_
      - _norwegian_
      - _persian_
      - _portuguese_
      - _romanian_
      - _russian_
      - _serbian_
      - _sorani_
      - _spanish_
      - _swedish_
      - _thai_
      - _turkish_
      - _none_
    _types.Name:
      type: string
    _types.aggregations.CompositeAggregationSource:
      type: object
      properties:
        terms:
          description: A terms aggregation.
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.CompositeTermsAggregation'
        histogram:
          description: A histogram aggregation.
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.CompositeHistogramAggregation'
        date_histogram:
          description: A date histogram aggregation.
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.CompositeDateHistogramAggregation'
        geotile_grid:
          description: A geotile grid aggregation.
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.CompositeGeoTileGridAggregation'
      minProperties: 1
      maxProperties: 1
    _types.query_dsl.SpanFirstQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          end:
            description: Controls the maximum end position permitted in a match.
            type: number
          match:
            description: Can be any other span type query.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
        required:
        - end
        - match
    _types.aggregations.RareTermsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          exclude:
            description: Terms that should be excluded from the aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsExclude'
          field:
            description: The field from which to return rare terms.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          include:
            description: Terms that should be included in the aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsInclude'
          max_doc_count:
            description: The maximum number of documents a term should appear in.
            default: 1.0
            type: number
          missing:
            description: 'The value to apply to documents that do not have a value.

              By default, documents without a value are ignored.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.Missing'
          precision:
            description: 'The precision of the internal CuckooFilters.

              Smaller precision leads to better approximation, but higher memory usage.'
            default: 0.001
            type: number
          value_type:
            type: string
    _types.query_dsl.BoostingQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          negative_boost:
            description: Floating point number between 0 and 1.0 used to decrease the relevance scores of documents matching the `negative` query.
            type: number
          negative:
            description: Query used to decrease the relevance score of matching documents.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          positive:
            description: Any returned documents must match this query.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
        required:
        - negative_boost
        - negative
        - positive
    _types.WktGeoBounds:
      type: object
      properties:
        wkt:
          type: string
      required:
      - wkt
    ml._types.TrainedModelAssignmentTaskParameters:
      type: object
      properties:
        model_bytes:
          description: The size of the trained model in bytes.
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
        model_id:
          description: The unique identifier for the trained model.
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        deployment_id:
          description: The unique identifier for the trained model deployment.
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        cache_size:
          description: The size of the trained model cache.
          x-state: Generally available; Added in 8.4.0
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
        number_of_allocations:
          description: The total number of allocations this model is assigned across ML nodes.
          type: number
        priority:
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainingPriority'
        per_deployment_memory_bytes:
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
        per_allocation_memory_bytes:
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
        queue_capacity:
          description: Number of inference requests are allowed in the queue at a time.
          type: number
        threads_per_allocation:
          description: Number of threads per allocation.
          type: number
      required:
      - model_bytes
      - model_id
      - deployment_id
      - number_of_allocations
      - priority
      - per_deployment_memory_bytes
      - per_allocation_memory_bytes
      - queue_capacity
      - threads_per_allocation
    ml._types.NerInferenceUpdateOptions:
      type: object
      properties:
        tokenization:
          description: The tokenization options to update when inferring
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpTokenizationUpdateOptions'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
    _types.aggregations.ScriptedHeuristic:
      type: object
      properties:
        script:
          allOf:
          - $ref: '#/components/schemas/_types.Script'
      required:
      - script
    _global.search._types.PointInTimeReference:
      type: object
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        keep_alive:
          allOf:
          - $ref: '#/components/schemas/_types.Duration'
      required:
      - id
    _types.CoordsGeoBounds:
      type: object
      properties:
        top:
          type: number
        bottom:
          type: number
        left:
          type: number
        right:
          type: number
      required:
      - top
      - bottom
      - left
      - right
    _types.aggregations.CumulativeSumAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
    _types.query_dsl.WildcardQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          case_insensitive:
            description: Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping.
            x-state: Generally available; Added in 7.10.0
            type: boolean
          rewrite:
            description: Method used to rewrite the query.
            allOf:
            - $ref: '#/components/schemas/_types.MultiTermQueryRewrite'
          value:
            description: Wildcard pattern for terms you wish to find in the provided field. Required, when wildcard is not set.
            type: string
          wildcard:
            description: Wildcard pattern for terms you wish to find in the provided field. Required, when value is not set.
            type: string
    _types.query_dsl.TermRangeQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBasestring'
      - type: object
    _types.query_dsl.MatchBoolPrefixQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          analyzer:
            description: Analyzer used to convert the text in the query value into tokens.
            type: string
          fuzziness:
            description: 'Maximum edit distance allowed for matching.

              Can be applied to the term subqueries constructed for all terms but the final term.'
            allOf:
            - $ref: '#/components/schemas/_types.Fuzziness'
          fuzzy_rewrite:
            description: 'Method used to rewrite the query.

              Can be applied to the term subqueries constructed for all terms but the final term.'
            allOf:
            - $ref: '#/components/schemas/_types.MultiTermQueryRewrite'
          fuzzy_transpositions:
            description: '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.'
            default: true
            type: boolean
          max_expansions:
            description: 'Maximum number of terms to which the query will expand.

              Can be applied to the term subqueries constructed for all terms but the final term.'
            default: 50.0
            type: number
          minimum_should_match:
            description: 'Minimum number of clauses that must match for a document to be returned.

              Applied to the constructed bool query.'
            allOf:
            - $ref: '#/components/schemas/_types.MinimumShouldMatch'
          operator:
            description: 'Boolean logic used to interpret text in the query value.

              Applied to the constructed bool query.'
            default: '''or'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.Operator'
          prefix_length:
            description: 'Number of beginning characters left unchanged for fuzzy matching.

              Can be applied to the term subqueries constructed for all terms but the final term.'
            default: 0.0
            type: number
          query:
            description: 'Terms you wish to find in the provided field.

              The last term is used in a prefix query.'
            type: string
        required:
        - query
    _types.query_dsl.SimpleQueryStringQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          analyzer:
            description: Analyzer used to convert text in the query string into tokens.
            type: string
          analyze_wildcard:
            description: If `true`, the query attempts to analyze wildcard terms in the query string.
            default: false
            type: boolean
          auto_generate_synonyms_phrase_query:
            description: If `true`, the parser creates a match_phrase query for each multi-position token.
            default: true
            type: boolean
          default_operator:
            description: Default boolean logic used to interpret text in the query string if no operators are specified.
            default: '''or'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.Operator'
          fields:
            description: 'Array of fields you wish to search.

              Accepts wildcard expressions.

              You also can boost relevance scores for matches to particular fields using a caret (`^`) notation.

              Defaults to the `index.query.default_field index` setting, which has a default value of `*`.'
            type: array
            items:
              $ref: '#/components/schemas/_types.Field'
          flags:
            description: List of enabled operators for the simple query string syntax.
            default: ALL
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.SimpleQueryStringFlags'
          fuzzy_max_expansions:
            description: Maximum number of terms to which the query expands for fuzzy matching.
            default: 50.0
            type: number
          fuzzy_prefix_length:
            description: Number of beginning characters left unchanged for fuzzy matching.
            default: 0.0
            type: number
          fuzzy_transpositions:
            description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
            type: boolean
          lenient:
            description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.
            default: false
            type: boolean
          minimum_should_match:
            description: Minimum number of clauses that must match for a document to be returned.
            allOf:
            - $ref: '#/components/schemas/_types.MinimumShouldMatch'
          query:
            description: Query string in the simple query string syntax you wish to parse and use for search.
            type: string
          quote_field_suffix:
            description: Suffix appended to quoted text in the query string.
            type: string
        required:
        - query
    ml._types.InferenceResponseResult:
      type: object
      properties:
        entities:
          description: If the model is trained for named entity recognition (NER) tasks, the response contains the recognized entities.
          type: array
          items:
            $ref: '#/components/schemas/ml._types.TrainedModelEntities'
        is_truncated:
          description: 'Indicates whether the input text was truncated to meet the model''s maximum sequence length limit. This property

            is present only when it is true.'
          type: boolean
        predicted_value:
          description: 'If the model is trained for a text classification or zero shot classification task, the response is the

            predicted class.

            For named entity recognition (NER) tasks, it contains the annotated text output.

            For fill mask tasks, it contains the top prediction for replacing the mask token.

            For text embedding tasks, it contains the raw numerical text embedding values.

            For regression models, its a numerical value

            For classification models, it may be an integer, double, boolean or string depending on prediction type'
          oneOf:
          - $ref: '#/components/schemas/ml._types.PredictedValue'
          - type: array
            items:
              $ref: '#/components/schemas/ml._types.PredictedValue'
        predicted_value_sequence:
          description: 'For fill mask tasks, the response contains the input text sequence with the mask token replaced by the predicted

            value.

            Additionally'
          type: string
        prediction_probability:
          description: Specifies a probability for the predicted value.
          type: number
        prediction_score:
          description: Specifies a confidence score for the predicted value.
          type: number
        top_classes:
          description: 'For fill mask, text classification, and zero shot classification tasks, the response contains a list of top

            class entries.'
          type: array
          items:
            $ref: '#/components/schemas/ml._types.TopClassEntry'
        warning:
          description: If the request failed, the response contains the reason for the failure.
          type: string
        feature_importance:
          description: The feature importance for the inference results. Relevant only for classification or regression models
          type: array
          items:
            $ref: '#/components/schemas/ml._types.TrainedModelInferenceFeatureImportance'
    _types.aggregations.TermsInclude:
      oneOf:
      - type: string
      - type: array
        items:
          type: string
      - $ref: '#/components/schemas/_types.aggregations.TermsPartition'
    _types.query_dsl.MatchAllQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
    ml._types.QuestionAnsweringInferenceOptions:
      description: Question answering inference options
      type: object
      properties:
        num_top_classes:
          description: Specifies the number of top class predictions to return. Defaults to 0.
          type: number
        tokenization:
          description: The tokenization options to update when inferring
          allOf:
          - $ref: '#/components/schemas/ml._types.TokenizationConfigContainer'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        max_answer_length:
          description: The maximum answer length to consider
          type: number
    _types.UnitFloatMillis:
      description: Time unit for fractional milliseconds
      type: number
    _types.RankBase:
      type: object
    _types.query_dsl.DateDecayFunction:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBaseDateMathDuration'
      - type: object
    _types.aggregations.SignificantTermsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          background_filter:
            description: A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          chi_square:
            description: Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ChiSquareHeuristic'
          exclude:
            description: Terms to exclude.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsExclude'
          execution_hint:
            description: 'Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsAggregationExecutionHint'
          field:
            description: The field from which to return significant terms.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          gnd:
            description: Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic'
          include:
            description: Terms to include.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsInclude'
          jlh:
            description: Use JLH score as the significance score.
            allOf:
            - $ref: '#/components/schemas/_types.EmptyObject'
          min_doc_count:
            description: Only return terms that are found in more than `min_doc_count` hits.
            default: 3.0
            type: number
          mutual_information:
            description: Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MutualInformationHeuristic'
          percentage:
            description: A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.PercentageScoreHeuristic'
          script_heuristic:
            description: Customized score, implemented via a script.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ScriptedHeuristic'
          p_value:
            description: 'Significant terms heuristic that calculates the p-value between the term existing in foreground and background sets.


              The p-value is the probability of obtaining test results at least as extreme as

              the results actually observed, under the assumption that the null hypothesis is

              correct. The p-value is calculated assuming that the foreground set and the

              background set are independent https://en.wikipedia.org/wiki/Bernoulli_trial, with the null

              hypothesis that the probabilities are the same.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.PValueHeuristic'
          shard_min_doc_count:
            description: '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`.'
            type: number
          shard_size:
            description: 'Can be used to control the volumes 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.'
            type: number
          size:
            description: The number of buckets returned out of the overall terms list.
            type: number
    _types.RescorerRetriever:
      allOf:
      - $ref: '#/components/schemas/_types.RetrieverBase'
      - type: object
        properties:
          retriever:
            description: Inner retriever.
            allOf:
            - $ref: '#/components/schemas/_types.RetrieverContainer'
          rescore:
            oneOf:
            - $ref: '#/components/schemas/_global.search._types.Rescore'
            - type: array
              items:
                $ref: '#/components/schemas/_global.search._types.Rescore'
        required:
        - retriever
        - rescore
    _types.aggregations.MaxBucketAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
    _types.aggregations.MissingOrder:
      type: string
      enum:
      - first
      - last
      - default
    _types.AcknowledgedResponseBase:
      type: object
      properties:
        acknowledged:
          description: For a successful response, this value is always true. On failure, an exception is returned instead.
          type: boolean
      required:
      - acknowledged
    _types.query_dsl.ParentIdQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          id:
            description: ID of the parent document.
            allOf:
            - $ref: '#/components/schemas/_types.Id'
          ignore_unmapped:
            description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.
            default: false
            type: boolean
          type:
            description: Name of the child relationship mapped for the `join` field.
            allOf:
            - $ref: '#/components/schemas/_types.RelationName'
    ml._types.TextClassificationInferenceUpdateOptions:
      type: object
      properties:
        num_top_classes:
          description: Specifies the number of top class predictions to return. Defaults to 0.
          type: number
        tokenization:
          description: The tokenization options to update when inferring
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpTokenizationUpdateOptions'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        classification_labels:
          description: Classification labels to apply other than the stored labels. Must have the same deminsions as the default configured labels
          type: array
          items:
            type: string
    _types.query_dsl.ZeroTermsQuery:
      type: string
      enum:
      - all
      - none
    _types.aggregations.TermsPartition:
      type: object
      properties:
        num_partitions:
          description: The number of partitions.
          type: number
        partition:
          description: The partition number for this request.
          type: number
      required:
      - num_partitions
      - partition
    _types.Sort:
      oneOf:
      - $ref: '#/components/schemas/_types.SortCombinations'
      - type: array
        items:
          $ref: '#/components/schemas/_types.SortCombinations'
    _types.aggregations.NormalizeAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          method:
            description: "The specific method to apply.\n\nSupported values include:\n  - `rescale_0_1`: This method rescales the data such that the minimum number is 0, and the maximum number is 1, with the rest normalized linearly in-between.\n  - `rescale_0_100`: This method rescales the data such that the minimum number is 0, and the maximum number is 100, with the rest normalized linearly in-between.\n  - `percent_of_sum`: This method normalizes each value so that it represents a percentage of the total sum it attributes to.\n  - `mean`: This method normalizes such that each value is normalized by how much it differs from the average.\n  - `z-score`: This method normalizes such that each value represents how far it is from the mean relative to the standard deviation.\n  - `softmax`: This method normalizes such that each value is exponentiated and relative to the sum of the exponents of the original values.\n\n"
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.NormalizeMethod'
    _types.aggregations.FrequentItemSetsAggregation:
      type: object
      properties:
        fields:
          description: Fields to analyze.
          type: array
          items:
            $ref: '#/components/schemas/_types.aggregations.FrequentItemSetsField'
        minimum_set_size:
          description: The minimum size of one item set.
          default: 1.0
          type: number
        minimum_support:
          description: The minimum support of one item set.
          default: 0.1
          type: number
        size:
          description: The number of top item sets to return.
          default: 10.0
          type: number
        filter:
          description: Query that filters documents from analysis.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
      required:
      - fields
    _types.query_dsl.TermsQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
    ml._types.ClassificationInferenceOptions:
      type: object
      properties:
        num_top_classes:
          description: Specifies the number of top class predictions to return. Defaults to 0.
          type: number
        num_top_feature_importance_values:
          description: Specifies the maximum number of feature importance values per document.
          default: 0.0
          type: number
        prediction_field_type:
          description: 'Specifies the type of the predicted field to write. Acceptable values are: string, number, boolean. When boolean is provided 1.0 is transformed to true and 0.0 to false.'
          type: string
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        top_classes_results_field:
          description: Specifies the field to which the top classes are written. Defaults to top_classes.
          type: string
    _types.aggregations.MissingAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          field:
            description: The name of the field.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          missing:
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.Missing'
    _types.query_dsl.FunctionBoostMode:
      type: string
      enum:
      - multiply
      - replace
      - sum
      - avg
      - max
      - min
    _types.aggregations.CustomCategorizeTextAnalyzer:
      type: object
      properties:
        char_filter:
          type: array
          items:
            type: string
        tokenizer:
          type: string
        filter:
          type: array
          items:
            type: string
    _types.query_dsl.LikeDocument:
      type: object
      properties:
        doc:
          description: A document not present in the index.
          type: object
        fields:
          type: array
          items:
            $ref: '#/components/schemas/_types.Field'
        _id:
          description: ID of a document.
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        _index:
          description: Index of a document.
          allOf:
          - $ref: '#/components/schemas/_types.IndexName'
        per_field_analyzer:
          description: Overrides the default analyzer.
          type: object
          additionalProperties:
            type: string
        routing:
          allOf:
          - $ref: '#/components/schemas/_types.Routing'
        version:
          allOf:
          - $ref: '#/components/schemas/_types.VersionNumber'
        version_type:
          description: "\n\nSupported values include:\n  - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n  - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n  - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n"
          default: '''internal'''
          allOf:
          - $ref: '#/components/schemas/_types.VersionType'
    _types.TextSimilarityReranker:
      allOf:
      - $ref: '#/components/schemas/_types.RetrieverBase'
      - type: object
        properties:
          retriever:
            description: The nested retriever which will produce the first-level results, that will later be used for reranking.
            allOf:
            - $ref: '#/components/schemas/_types.RetrieverContainer'
          rank_window_size:
            description: This value determines how many documents we will consider from the nested retriever.
            type: number
          inference_id:
            description: Unique identifier of the inference endpoint created using the inference API.
            type: string
          inference_text:
            description: The text snippet used as the basis for similarity comparison.
            type: string
          field:
            description: The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text.
            type: string
          chunk_rescorer:
            description: Whether to rescore on only the best matching chunks.
            x-state: Generally available; Added in 9.2.0
            allOf:
            - $ref: '#/components/schemas/_types.ChunkRescorer'
        required:
        - retriever
        - inference_text
        - field
    _types.aggregations.SignificantTextAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          background_filter:
            description: A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          chi_square:
            description: Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ChiSquareHeuristic'
          exclude:
            description: Values to exclude.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsExclude'
          execution_hint:
            description: Determines whether the aggregation will use field values directly or global ordinals.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsAggregationExecutionHint'
          field:
            description: The field from which to return significant text.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          filter_duplicate_text:
            description: Whether to out duplicate text to deal with noisy data.
            type: boolean
          gnd:
            description: Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GoogleNormalizedDistanceHeuristic'
          include:
            description: Values to include.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsInclude'
          jlh:
            description: Use JLH score as the significance score.
            allOf:
            - $ref: '#/components/schemas/_types.EmptyObject'
          min_doc_count:
            description: Only return values that are found in more than `min_doc_count` hits.
            default: 3.0
            type: number
          mutual_information:
            description: Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MutualInformationHeuristic'
          percentage:
            description: A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.PercentageScoreHeuristic'
          script_heuristic:
            description: Customized score, implemented via a script.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ScriptedHeuristic'
          shard_min_doc_count:
            description: 'Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.

              Values will only be considered if their local shard frequency within the set is higher than the `shard_min_doc_count`.'
            type: number
          shard_size:
            description: '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.'
            type: number
          size:
            description: The number of buckets returned out of the overall terms list.
            type: number
          source_fields:
            description: Overrides the JSON `_source` fields from which text will be analyzed.
            allOf:
            - $ref: '#/components/schemas/_types.Fields'
    ml.put_trained_model.TargetMeanEncodingPreprocessor:
      type: object
      properties:
        field:
          type: string
        feature_name:
          type: string
        target_map:
          type: object
          additionalProperties:
            type: number
        default_value:
          type: number
      required:
      - field
      - feature_name
      - target_map
      - default_value
    ml._types.DeploymentAllocationState:
      type: string
      enum:
      - started
      - starting
      - fully_allocated
    _types.query_dsl.DistanceFeatureQueryBaseDateMathDuration:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          origin:
            description: 'Date or point of origin used to calculate distances.

              If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.

              Date Math, such as `now-1h`, is supported.

              If the field value is a `geo_point` field, the `origin` value must be a geopoint.'
            allOf:
            - $ref: '#/components/schemas/_types.DateMath'
          pivot:
            description: 'Distance from the `origin` at which relevance scores receive half of the `boost` value.

              If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.'
            allOf:
            - $ref: '#/components/schemas/_types.Duration'
          field:
            description: 'Name of the field used to calculate distances. This field must meet the following criteria:

              be a `date`, `date_nanos` or `geo_point` field;

              have an `index` mapping parameter value of `true`, which is the default;

              have an `doc_values` mapping parameter value of `true`, which is the default.'
            allOf:
            - $ref: '#/components/schemas/_types.Field'
        required:
        - origin
        - pivot
        - field
    _types.aggregations.CompositeAggregateKey:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/_types.FieldValue'
    _types.ByteSize:
      oneOf:
      - type: number
      - type: string
    _types.query_dsl.FieldAndFormat:
      description: A reference to a field with formatting instructions on how to return the value
      type: object
      properties:
        field:
          description: A wildcard pattern. The request returns values for field names matching this pattern.
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        format:
          description: The format in which the values are returned.
          type: string
        include_unmapped:
          type: boolean
      required:
      - field
    _types.query_dsl.MatchNoneQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
    _types.aggregations.StatsBucketAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
    _types.aggregations.RateAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase'
      - type: object
        properties:
          unit:
            description: 'The interval used to calculate the rate.

              By default, the interval of the `date_histogram` is used.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CalendarInterval'
          mode:
            description: "How the rate is calculated.\n\nSupported values include:\n  - `sum`: Calculates the sum of all values of the field.\n  - `value_count`: Uses the number of values of the field.\n\n"
            default: sum
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.RateMode'
    _types.query_dsl.DistanceFeatureQueryBase:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          origin:
            description: 'Date or point of origin used to calculate distances.

              If the `field` value is a `date` or `date_nanos` field, the `origin` value must be a date.

              Date Math, such as `now-1h`, is supported.

              If the field value is a `geo_point` field, the `origin` value must be a geopoint.'
            type: object
          pivot:
            description: 'Distance from the `origin` at which relevance scores receive half of the `boost` value.

              If the `field` value is a `date` or `date_nanos` field, the `pivot` value must be a time unit, such as `1h` or `10d`. If the `field` value is a `geo_point` field, the `pivot` value must be a distance unit, such as `1km` or `12m`.'
            type: object
          field:
            description: 'Name of the field used to calculate distances. This field must meet the following criteria:

              be a `date`, `date_nanos` or `geo_point` field;

              have an `index` mapping parameter value of `true`, which is the default;

              have an `doc_values` mapping parameter value of `true`, which is the default.'
            allOf:
            - $ref: '#/components/schemas/_types.Field'
        required:
        - origin
        - pivot
        - field
    _types.aggregations.RateMode:
      type: string
      enum:
      - sum
      - value_count
    ml.put_trained_model.TrainedModelTree:
      type: object
      properties:
        classification_labels:
          type: array
          items:
            type: string
        feature_names:
          type: array
          items:
            type: string
        target_type:
          type: string
        tree_structure:
          type: array
          items:
            $ref: '#/components/schemas/ml.put_trained_model.TrainedModelTreeNode'
      required:
      - feature_names
      - tree_structure
    _types.query_dsl.DecayFunction:
      oneOf:
      - $ref: '#/components/schemas/_types.query_dsl.UntypedDecayFunction'
      - $ref: '#/components/schemas/_types.query_dsl.DateDecayFunction'
      - $ref: '#/components/schemas/_types.query_dsl.NumericDecayFunction'
      - $ref: '#/components/schemas/_types.query_dsl.GeoDecayFunction'
    ml._types.TotalFeatureImportanceStatistics:
      type: object
      properties:
        mean_magnitude:
          description: The average magnitude of this feature across all the training data. This value is the average of the absolute values of the importance for this feature.
          type: number
        max:
          description: The maximum importance value across all the training data for this feature.
          type: number
        min:
          description: The minimum importance value across all the training data for this feature.
          type: number
      required:
      - mean_magnitude
      - max
      - min
    _global.search._types.InnerHits:
      type: object
      properties:
        name:
          description: 'The name for the particular inner hit definition in the response.

            Useful when a search request contains multiple inner hits.'
          allOf:
          - $ref: '#/components/schemas/_types.Name'
        size:
          description: The maximum number of hits to return per `inner_hits`.
          default: 3.0
          type: number
        from:
          description: Inner hit starting document offset.
          default: 0.0
          type: number
        collapse:
          allOf:
          - $ref: '#/components/schemas/_global.search._types.FieldCollapse'
        docvalue_fields:
          type: array
          items:
            $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat'
        explain:
          type: boolean
        highlight:
          allOf:
          - $ref: '#/components/schemas/_global.search._types.Highlight'
        ignore_unmapped:
          type: boolean
        script_fields:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.ScriptField'
        seq_no_primary_term:
          type: boolean
        fields:
          type: array
          items:
            $ref: '#/components/schemas/_types.Field'
        sort:
          description: 'How the inner hits should be sorted per `inner_hits`.

            By default, inner hits are sorted by score.'
          allOf:
          - $ref: '#/components/schemas/_types.Sort'
        _source:
          allOf:
          - $ref: '#/components/schemas/_global.search._types.SourceConfig'
        stored_fields:
          allOf:
          - $ref: '#/components/schemas/_types.Fields'
        track_scores:
          default: false
          type: boolean
        version:
          type: boolean
    _types.aggregations.AggregationContainer:
      allOf:
      - type: object
        properties:
          aggregations:
            description: 'Sub-aggregations for this aggregation.

              Only applies to bucket aggregations.'
            type: object
            additionalProperties:
              $ref: '#/components/schemas/_types.aggregations.AggregationContainer'
          meta:
            allOf:
            - $ref: '#/components/schemas/_types.Metadata'
      - type: object
        properties:
          adjacency_matrix:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-adjacency-matrix-aggregation
            description: 'A bucket aggregation returning a form of adjacency matrix.

              The request provides a collection of named filter expressions, similar to the `filters` aggregation.

              Each bucket in the response represents a non-empty cell in the matrix of intersecting filters.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.AdjacencyMatrixAggregation'
          auto_date_histogram:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-autodatehistogram-aggregation
            description: A multi-bucket aggregation similar to the date histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.AutoDateHistogramAggregation'
          avg:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-avg-aggregation
            description: A single-value metrics aggregation that computes the average of numeric values that are extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.AverageAggregation'
          avg_bucket:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-avg-bucket-aggregation
            description: 'A sibling pipeline aggregation which calculates the mean value of a specified metric in a sibling aggregation.

              The specified metric must be numeric and the sibling aggregation must be a multi-bucket aggregation.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.AverageBucketAggregation'
          boxplot:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-boxplot-aggregation
            description: A metrics aggregation that computes a box plot of numeric values extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.BoxplotAggregation'
          bucket_script:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation
            description: A parent pipeline aggregation which runs a script which can perform per bucket computations on metrics in the parent multi-bucket aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.BucketScriptAggregation'
          bucket_selector:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-selector-aggregation
            description: A parent pipeline aggregation which runs a script to determine whether the current bucket will be retained in the parent multi-bucket aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.BucketSelectorAggregation'
          bucket_sort:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-bucket-sort-aggregation
            description: A parent pipeline aggregation which sorts the buckets of its parent multi-bucket aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.BucketSortAggregation'
          bucket_count_ks_test:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-count-ks-test-aggregation
            description: A sibling pipeline aggregation which runs a two sample Kolmogorov–Smirnov test ("K-S test") against a provided distribution and the distribution implied by the documents counts in the configured sibling aggregation.
            x-state: Technical preview
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.BucketKsAggregation'
          bucket_correlation:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-correlation-aggregation
            description: A sibling pipeline aggregation which runs a correlation function on the configured sibling multi-bucket aggregation.
            x-state: Technical preview
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationAggregation'
          cardinality:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cardinality-aggregation
            description: A single-value metrics aggregation that calculates an approximate count of distinct values.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CardinalityAggregation'
          cartesian_bounds:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cartesian-bounds-aggregation
            description: A metric aggregation that computes the spatial bounding box containing all values for a Point or Shape field.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CartesianBoundsAggregation'
          cartesian_centroid:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-cartesian-centroid-aggregation
            description: A metric aggregation that computes the weighted centroid from all coordinate values for point and shape fields.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CartesianCentroidAggregation'
          categorize_text:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-categorize-text-aggregation
            description: A multi-bucket aggregation that groups semi-structured text into buckets.
            x-state: Technical preview
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CategorizeTextAggregation'
          change_point:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-change-point-aggregation
            description: 'A sibling pipeline that detects, spikes, dips, and change points in a metric.

              Given a distribution of values provided by the sibling multi-bucket aggregation,

              this aggregation indicates the bucket of any spike or dip and/or the bucket at which

              the largest change in the distribution of values, if they are statistically significant.

              There must be at least 22 bucketed values. Fewer than 1,000 is preferred.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ChangePointAggregation'
          children:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-children-aggregation
            description: A single bucket aggregation that selects child documents that have the specified type, as defined in a `join` field.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ChildrenAggregation'
          composite:
            description: 'A multi-bucket aggregation that creates composite buckets from different sources.

              Unlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CompositeAggregation'
          cumulative_cardinality:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation
            description: A parent pipeline aggregation which calculates the cumulative cardinality in a parent `histogram` or `date_histogram` aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CumulativeCardinalityAggregation'
          cumulative_sum:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation
            description: A parent pipeline aggregation which calculates the cumulative sum of a specified metric in a parent `histogram` or `date_histogram` aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CumulativeSumAggregation'
          date_histogram:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-datehistogram-aggregation
            description: 'A multi-bucket values source based aggregation that can be applied on date values or date range values extracted from the documents.

              It dynamically builds fixed size (interval) buckets over the values.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.DateHistogramAggregation'
          date_range:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-daterange-aggregation
            description: A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.DateRangeAggregation'
          derivative:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation
            description: A parent pipeline aggregation which calculates the derivative of a specified metric in a parent `histogram` or `date_histogram` aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.DerivativeAggregation'
          diversified_sampler:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-diversified-sampler-aggregation
            description: 'A filtering aggregation used to limit any sub aggregations'' processing to a sample of the top-scoring documents.

              Similar to the `sampler` aggregation, but adds the ability to limit the number of matches that share a common value.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.DiversifiedSamplerAggregation'
          extended_stats:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-extendedstats-aggregation
            description: A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ExtendedStatsAggregation'
          extended_stats_bucket:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation
            description: A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ExtendedStatsBucketAggregation'
          frequent_item_sets:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-frequent-item-sets-aggregation
            description: A bucket aggregation which finds frequent item sets, a form of association rules mining that identifies items that often occur together.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.FrequentItemSetsAggregation'
          filter:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filter-aggregation
            description: A single bucket aggregation that narrows the set of documents to those that match a query.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          filters:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-filters-aggregation
            description: A multi-bucket aggregation where each bucket contains the documents that match a query.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.FiltersAggregation'
          geo_bounds:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geobounds-aggregation
            description: A metric aggregation that computes the geographic bounding box containing all values for a Geopoint or Geoshape field.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GeoBoundsAggregation'
          geo_centroid:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geocentroid-aggregation
            description: A metric aggregation that computes the weighted centroid from all coordinate values for geo fields.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GeoCentroidAggregation'
          geo_distance:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geodistance-aggregation
            description: 'A multi-bucket aggregation that works on `geo_point` fields.

              Evaluates the distance of each document value from an origin point and determines the buckets it belongs to, based on ranges defined in the request.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GeoDistanceAggregation'
          geohash_grid:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohashgrid-aggregation
            description: 'A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.

              Each cell is labeled using a geohash which is of user-definable precision.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GeoHashGridAggregation'
          geo_line:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-geo-line
            description: Aggregates all `geo_point` values within a bucket into a `LineString` ordered by the chosen sort field.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GeoLineAggregation'
          geotile_grid:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geotilegrid-aggregation
            description: 'A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.

              Each cell corresponds to a map tile as used by many online map sites.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GeoTileGridAggregation'
          geohex_grid:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-geohexgrid-aggregation
            description: 'A multi-bucket aggregation that groups `geo_point` and `geo_shape` values into buckets that represent a grid.

              Each cell corresponds to a H3 cell index and is labeled using the H3Index representation.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GeohexGridAggregation'
          global:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-global-aggregation
            description: 'Defines a single bucket of all the documents within the search execution context.

              This context is defined by the indices and the document types you’re searching on, but is not influenced by the search query itself.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GlobalAggregation'
          histogram:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-histogram-aggregation
            description: 'A multi-bucket values source based aggregation that can be applied on numeric values or numeric range values extracted from the documents.

              It dynamically builds fixed size (interval) buckets over the values.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.HistogramAggregation'
          ip_range:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-iprange-aggregation
            description: A multi-bucket value source based aggregation that enables the user to define a set of IP ranges - each representing a bucket.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.IpRangeAggregation'
          ip_prefix:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-ipprefix-aggregation
            description: A bucket aggregation that groups documents based on the network or sub-network of an IP address.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.IpPrefixAggregation'
          inference:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-inference-bucket-aggregation
            description: A parent pipeline aggregation which loads a pre-trained model and performs inference on the collated result fields from the parent bucket aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.InferenceAggregation'
          line:
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GeoLineAggregation'
          matrix_stats:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-matrix-stats-aggregation
            description: 'A numeric aggregation that computes the following statistics over a set of document fields: `count`, `mean`, `variance`, `skewness`, `kurtosis`, `covariance`, and `covariance`.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MatrixStatsAggregation'
          max:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-max-aggregation
            description: A single-value metrics aggregation that returns the maximum value among the numeric values extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MaxAggregation'
          max_bucket:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation
            description: A sibling pipeline aggregation which identifies the bucket(s) with the maximum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MaxBucketAggregation'
          median_absolute_deviation:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-median-absolute-deviation-aggregation
            description: A single-value aggregation that approximates the median absolute deviation of its search results.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MedianAbsoluteDeviationAggregation'
          min:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-min-aggregation
            description: A single-value metrics aggregation that returns the minimum value among numeric values extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MinAggregation'
          min_bucket:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation
            description: A sibling pipeline aggregation which identifies the bucket(s) with the minimum value of a specified metric in a sibling aggregation and outputs both the value and the key(s) of the bucket(s).
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MinBucketAggregation'
          missing:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-missing-aggregation
            description: A field data based single bucket aggregation, that creates a bucket of all documents in the current document set context that are missing a field value (effectively, missing a field or having the configured NULL value set).
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MissingAggregation'
          moving_avg:
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregation'
          moving_percentiles:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-moving-percentiles-aggregation
            description: Given an ordered series of percentiles, "slides" a window across those percentiles and computes cumulative percentiles.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MovingPercentilesAggregation'
          moving_fn:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-movfn-aggregation
            description: 'Given an ordered series of data, "slides" a window across the data and runs a custom script on each window of data.

              For convenience, a number of common functions are predefined such as `min`, `max`, and moving averages.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MovingFunctionAggregation'
          multi_terms:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-multi-terms-aggregation
            description: A multi-bucket value source based aggregation where buckets are dynamically built - one per unique set of values.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MultiTermsAggregation'
          nested:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-nested-aggregation
            description: A special single bucket aggregation that enables aggregating nested documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.NestedAggregation'
          normalize:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-normalize-aggregation
            description: A parent pipeline aggregation which calculates the specific normalized/rescaled value for a specific bucket value.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.NormalizeAggregation'
          parent:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-parent-aggregation
            description: A special single bucket aggregation that selects parent documents that have the specified type, as defined in a `join` field.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ParentAggregation'
          percentile_ranks:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-rank-aggregation
            description: A multi-value metrics aggregation that calculates one or more percentile ranks over numeric values extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.PercentileRanksAggregation'
          percentiles:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-percentile-aggregation
            description: A multi-value metrics aggregation that calculates one or more percentiles over numeric values extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.PercentilesAggregation'
          percentiles_bucket:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation
            description: A sibling pipeline aggregation which calculates percentiles across all bucket of a specified metric in a sibling aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.PercentilesBucketAggregation'
          range:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-range-aggregation
            description: A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.RangeAggregation'
          rare_terms:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-rare-terms-aggregation
            description: A multi-bucket value source based aggregation which finds "rare" terms — terms that are at the long-tail of the distribution and are not frequent.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.RareTermsAggregation'
          rate:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-rate-aggregation
            description: 'Calculates a rate of documents or a field in each bucket.

              Can only be used inside a `date_histogram` or `composite` aggregation.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.RateAggregation'
          reverse_nested:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-reverse-nested-aggregation
            description: 'A special single bucket aggregation that enables aggregating on parent documents from nested documents.

              Should only be defined inside a `nested` aggregation.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ReverseNestedAggregation'
          random_sampler:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-random-sampler-aggregation
            description: 'A single bucket aggregation that randomly includes documents in the aggregated results.

              Sampling provides significant speed improvement at the cost of accuracy.'
            x-state: Technical preview; Added in 8.1.0
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.RandomSamplerAggregation'
          sampler:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-sampler-aggregation
            description: A filtering aggregation used to limit any sub aggregations' processing to a sample of the top-scoring documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.SamplerAggregation'
          scripted_metric:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-scripted-metric-aggregation
            description: A metric aggregation that uses scripts to provide a metric output.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ScriptedMetricAggregation'
          serial_diff:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-serialdiff-aggregation
            description: An aggregation that subtracts values in a time series from themselves at different time lags or periods.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.SerialDifferencingAggregation'
          significant_terms:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significantterms-aggregation
            description: Returns interesting or unusual occurrences of terms in a set.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.SignificantTermsAggregation'
          significant_text:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-significanttext-aggregation
            description: Returns interesting or unusual occurrences of free-text terms in a set.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.SignificantTextAggregation'
          stats:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-stats-aggregation
            description: A multi-value metrics aggregation that computes stats over numeric values extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.StatsAggregation'
          stats_bucket:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation
            description: A sibling pipeline aggregation which calculates a variety of stats across all bucket of a specified metric in a sibling aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.StatsBucketAggregation'
          string_stats:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-string-stats-aggregation
            description: A multi-value metrics aggregation that computes statistics over string values extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.StringStatsAggregation'
          sum:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-sum-aggregation
            description: A single-value metrics aggregation that sums numeric values that are extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.SumAggregation'
          sum_bucket:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation
            description: A sibling pipeline aggregation which calculates the sum of a specified metric across all buckets in a sibling aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.SumBucketAggregation'
          terms:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-terms-aggregation
            description: A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TermsAggregation'
          time_series:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-time-series-aggregation
            description: 'The time series aggregation queries data created using a time series index.

              This is typically data such as metrics or other data streams with a time component, and requires creating an index using the time series mode.'
            x-state: Technical preview
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TimeSeriesAggregation'
          top_hits:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-hits-aggregation
            description: A metric aggregation that returns the top matching documents per bucket.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TopHitsAggregation'
          t_test:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-ttest-aggregation
            description: A metrics aggregation that performs a statistical hypothesis test in which the test statistic follows a Student’s t-distribution under the null hypothesis on numeric values extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TTestAggregation'
          top_metrics:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-top-metrics
            description: A metric aggregation that selects metrics from the document with the largest or smallest sort value.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TopMetricsAggregation'
          value_count:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-valuecount-aggregation
            description: A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ValueCountAggregation'
          weighted_avg:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-metrics-weight-avg-aggregation
            description: A single-value metrics aggregation that computes the weighted average of numeric values that are extracted from the aggregated documents.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.WeightedAverageAggregation'
          variable_width_histogram:
            externalDocs:
              url: https://www.elastic.co/docs/reference/aggregations/search-aggregations-bucket-variablewidthhistogram-aggregation
            description: A multi-bucket aggregation similar to the histogram, except instead of providing an interval to use as the width of each bucket, a target number of buckets is provided.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.VariableWidthHistogramAggregation'
        minProperties: 1
        maxProperties: 1
    _types.query_dsl.RangeQueryBasestring:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          relation:
            description: "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n  - `within`: Matches documents with a range field value entirely within the query’s range.\n  - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n  - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n"
            default: intersects
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.RangeRelation'
          gt:
            description: Greater than.
            type: string
          gte:
            description: Greater than or equal to.
            type: string
          lt:
            description: Less than.
            type: string
          lte:
            description: Less than or equal to.
            type: string
    _types.query_dsl.IdsQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          values:
            description: An array of document IDs.
            allOf:
            - $ref: '#/components/schemas/_types.Ids'
    ml._types.DeploymentAssignmentState:
      type: string
      enum:
      - started
      - starting
      - stopping
      - failed
    _types.aggregations.TestPopulation:
      type: object
      properties:
        field:
          description: The field to aggregate.
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        script:
          allOf:
          - $ref: '#/components/schemas/_types.Script'
        filter:
          description: A filter used to define a set of records to run unpaired t-test on.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
      required:
      - field
    _types.RetrieverContainer:
      type: object
      properties:
        standard:
          description: A retriever that replaces the functionality of a traditional query.
          allOf:
          - $ref: '#/components/schemas/_types.StandardRetriever'
        knn:
          description: A retriever that replaces the functionality  of a knn search.
          allOf:
          - $ref: '#/components/schemas/_types.KnnRetriever'
        rrf:
          description: A retriever that produces top documents from reciprocal rank fusion (RRF).
          allOf:
          - $ref: '#/components/schemas/_types.RRFRetriever'
        text_similarity_reranker:
          description: A retriever that reranks the top documents based on a reranking model using the InferenceAPI
          allOf:
          - $ref: '#/components/schemas/_types.TextSimilarityReranker'
        rule:
          description: A retriever that replaces the functionality of a rule query.
          allOf:
          - $ref: '#/components/schemas/_types.RuleRetriever'
        rescorer:
          description: A retriever that re-scores only the results produced by its child retriever.
          allOf:
          - $ref: '#/components/schemas/_types.RescorerRetriever'
        linear:
          description: A retriever that supports the combination of different retrievers through a weighted linear combination.
          allOf:
          - $ref: '#/components/schemas/_types.LinearRetriever'
        pinned:
          description: 'A pinned retriever applies pinned documents to the underlying retriever.

            This retriever will rewrite to a PinnedQueryBuilder.'
          allOf:
          - $ref: '#/components/schemas/_types.PinnedRetriever'
        diversify:
          description: A retriever that diversifies the results from its child retriever.
          allOf:
          - $ref: '#/components/schemas/_types.DiversifyRetriever'
      minProperties: 1
      maxProperties: 1
    _types.query_dsl.UntypedDecayFunction:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBase'
      - type: object
    _types.query_dsl.TypeQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          value:
            type: string
        required:
        - value
    _types.ScriptSource:
      oneOf:
      - type: string
      - $ref: '#/components/schemas/_global.search._types.SearchRequestBody'
    _types.aggregations.HoltMovingAverageAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase'
      - type: object
        properties:
          model:
            type: string
            enum:
            - holt
          settings:
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.HoltLinearModelSettings'
        required:
        - model
        - settings
    _global.search._types.SourceFilter:
      type: object
      properties:
        exclude_vectors:
          description: 'If `true`, vector fields are excluded from the returned source.


            This option takes precedence over `includes`: any vector field will

            remain excluded even if it matches an `includes` rule.'
          type: boolean
        excludes:
          description: A list of fields to exclude from the returned source.
          allOf:
          - $ref: '#/components/schemas/_types.Fields'
        includes:
          description: A list of fields to include in the returned source.
          allOf:
          - $ref: '#/components/schemas/_types.Fields'
    _types.RRFRetriever:
      allOf:
      - $ref: '#/components/schemas/_types.RetrieverBase'
      - type: object
        properties:
          retrievers:
            description: A list of child retrievers to specify which sets of returned top documents will have the RRF formula applied to them. Each retriever can optionally include a weight parameter.
            type: array
            items:
              $ref: '#/components/schemas/_types.RRFRetrieverEntry'
          rank_constant:
            description: This value determines how much influence documents in individual result sets per query have over the final ranked result set.
            type: number
          rank_window_size:
            description: This value determines the size of the individual result sets per query.
            type: number
          query:
            type: string
          fields:
            type: array
            items:
              type: string
        required:
        - retrievers
    _types.aggregations.MaxAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase'
      - type: object
    _types.query_dsl.GeoBoundingBoxQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          type:
            deprecated: true
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.GeoExecution'
          validation_method:
            description: "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.\n\nSupported values include:\n  - `coerce`: Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.\n  - `ignore_malformed`: Accept geo points with invalid latitude or longitude.\n  - `strict`\n\n"
            default: '''strict'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.GeoValidationMethod'
          ignore_unmapped:
            description: '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.'
            default: false
            type: boolean
    _types.mapping.ChunkRescorerChunkingSettings:
      type: object
      properties:
        strategy:
          externalDocs:
            url: https://www.elastic.co/docs/explore-analyze/elastic-inference/inference-api#chunking-strategies
          description: "The chunking strategy: `sentence`, `word`, `none` or `recursive`.\n\n * If `strategy` is set to `recursive`, you must also specify:\n\n- `max_chunk_size`\n- either `separators` or`separator_group`\n\nLearn more about different chunking strategies in the linked documentation."
          default: sentence
          type: string
        separator_group:
          description: 'Only applicable to the `recursive` strategy and required when using it.


            Sets a predefined list of separators in the saved chunking settings based on the selected text type.

            Values can be `markdown` or `plaintext`.


            Using this parameter is an alternative to manually specifying a custom `separators` list.'
          type: string
        separators:
          description: 'Only applicable to the `recursive` strategy and required when using it.


            A list of strings used as possible split points when chunking text.


            Each string can be a plain string or a regular expression (regex) pattern.

            The system tries each separator in order to split the text, starting from the first item in the list.


            After splitting, it attempts to recombine smaller pieces into larger chunks that stay within

            the `max_chunk_size` limit, to reduce the total number of chunks generated.'
          type: array
          items:
            type: string
        max_chunk_size:
          description: 'The maximum size of a chunk in words.

            This value cannot be lower than `20` (for `sentence` strategy) or `10` (for `word` strategy).

            This value should not exceed the window size for the associated model.'
          default: 250.0
          type: number
        overlap:
          description: 'The number of overlapping words for chunks.

            It is applicable only to a `word` chunking strategy.

            This value cannot be higher than half the `max_chunk_size` value.'
          default: 100.0
          type: number
        sentence_overlap:
          description: 'The number of overlapping sentences for chunks.

            It is applicable only for a `sentence` chunking strategy.

            It can be either `1` or `0`.'
          default: 1.0
          type: number
      required:
      - max_chunk_size
    _types.VersionNumber:
      type: number
    _types.RankContainer:
      type: object
      properties:
        rrf:
          description: The reciprocal rank fusion parameters
          allOf:
          - $ref: '#/components/schemas/_types.RrfRank'
      minProperties: 1
      maxProperties: 1
    _types.query_dsl.GeoGridQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          geotile:
            allOf:
            - $ref: '#/components/schemas/_types.GeoTile'
          geohash:
            allOf:
            - $ref: '#/components/schemas/_types.GeoHash'
          geohex:
            allOf:
            - $ref: '#/components/schemas/_types.GeoHexCell'
        minProperties: 1
        maxProperties: 1
    _types.Id:
      type: string
    _types.DiversifyRetrieverTypes:
      type: string
      enum:
      - mmr
    _types.query_dsl.NestedQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          ignore_unmapped:
            description: Indicates whether to ignore an unmapped path and not return any documents instead of an error.
            default: false
            type: boolean
          inner_hits:
            description: If defined, each search hit will contain inner hits.
            allOf:
            - $ref: '#/components/schemas/_global.search._types.InnerHits'
          path:
            description: Path to the nested object you wish to search.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          query:
            description: Query you wish to run on nested objects in the path.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          score_mode:
            description: How scores for matching child objects affect the root parent document’s relevance score.
            default: '''avg'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.ChildScoreMode'
        required:
        - path
        - query
    _global.search._types.HighlightBase:
      type: object
      properties:
        type:
          description: "\n\nSupported values include:\n  - `plain`: The `plain` highlighter uses the standard Lucene highlighter\n  - `fvh`: The fvh highlighter uses the Lucene Fast Vector highlighter.\n  - `unified`: The unified highlighter uses the Lucene Unified Highlighter.\n\n"
          allOf:
          - $ref: '#/components/schemas/_global.search._types.HighlighterType'
        boundary_chars:
          description: A string that contains each boundary character.
          default: .,!? \t\n
          type: string
        boundary_max_scan:
          description: How far to scan for boundary characters.
          default: 20.0
          type: number
        boundary_scanner:
          description: "Specifies how to break the highlighted fragments: chars, sentence, or word.\nOnly valid for the unified and fvh highlighters.\nDefaults to `sentence` for the `unified` highlighter. Defaults to `chars` for the `fvh` highlighter.\n\nSupported values include:\n  - `chars`: Use the characters specified by `boundary_chars` as highlighting boundaries.\nThe `boundary_max_scan` setting controls how far to scan for boundary characters.\nOnly valid for the `fvh` highlighter.\n  - `sentence`: Break highlighted fragments at the next sentence boundary, as determined by Java’s `BreakIterator`.\nYou can specify the locale to use with `boundary_scanner_locale`.\nWhen used with the `unified` highlighter, the `sentence` scanner splits sentences bigger than `fragment_size` at the first word boundary next to fragment_size.\nYou can set `fragment_size` to `0` to never split any sentence.\n  - `word`: Break highlighted fragments at the next word boundary, as determined by Java’s `BreakIterator`.\nYou can specify the locale to use with `boundary_scanner_locale`.\n\n"
          allOf:
          - $ref: '#/components/schemas/_global.search._types.BoundaryScanner'
        boundary_scanner_locale:
          description: '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"`.'
          default: Locale.ROOT
          type: string
        force_source:
          deprecated: true
          type: boolean
        fragmenter:
          description: 'Specifies how text should be broken up in highlight snippets: `simple` or `span`.

            Only valid for the `plain` highlighter.'
          default: span
          allOf:
          - $ref: '#/components/schemas/_global.search._types.HighlighterFragmenter'
        fragment_size:
          description: The size of the highlighted fragment in characters.
          default: 100.0
          type: number
        highlight_filter:
          type: boolean
        highlight_query:
          description: 'Highlight matches for a query other than the search query.

            This is especially useful if you use a rescore query because those are not taken into account by highlighting by default.'
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
        max_fragment_length:
          type: number
        max_analyzed_offset:
          description: '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.'
          type: number
        no_match_size:
          description: The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.
          default: 0.0
          type: number
        number_of_fragments:
          description: '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.'
          default: 5.0
          type: number
        options:
          type: object
          additionalProperties:
            type: object
        order:
          description: 'Sorts highlighted fragments by score when set to `score`.

            By default, fragments will be output in the order they appear in the field (order: `none`).

            Setting this option to `score` will output the most relevant fragments first.

            Each highlighter applies its own logic to compute relevancy scores.'
          default: none
          allOf:
          - $ref: '#/components/schemas/_global.search._types.HighlighterOrder'
        phrase_limit:
          description: '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.'
          default: 256.0
          type: number
        post_tags:
          description: '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.'
          type: array
          items:
            type: string
        pre_tags:
          description: '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.'
          type: array
          items:
            type: string
        require_field_match:
          description: 'By default, only fields that contains a query match are highlighted.

            Set to `false` to highlight all fields.'
          default: true
          type: boolean
        tags_schema:
          description: Set to `styled` to use the built-in tag schema.
          allOf:
          - $ref: '#/components/schemas/_global.search._types.HighlighterTagsSchema'
    ml._types.QuestionAnsweringInferenceUpdateOptions:
      type: object
      properties:
        question:
          description: The question to answer given the inference context
          type: string
        num_top_classes:
          description: Specifies the number of top class predictions to return. Defaults to 0.
          type: number
        tokenization:
          description: The tokenization options to update when inferring
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpTokenizationUpdateOptions'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        max_answer_length:
          description: The maximum answer length to consider for extraction
          type: number
      required:
      - question
    ml.put_trained_model.Input:
      type: object
      properties:
        field_names:
          allOf:
          - $ref: '#/components/schemas/_types.Names'
      required:
      - field_names
    _types.aggregations.MovingAverageAggregation:
      discriminator:
        propertyName: model
        mapping:
          ewma: '#/components/schemas/_types.aggregations.EwmaMovingAverageAggregation'
          holt: '#/components/schemas/_types.aggregations.HoltMovingAverageAggregation'
          holt_winters: '#/components/schemas/_types.aggregations.HoltWintersMovingAverageAggregation'
          linear: '#/components/schemas/_types.aggregations.LinearMovingAverageAggregation'
          simple: '#/components/schemas/_types.aggregations.SimpleMovingAverageAggregation'
      oneOf:
      - $ref: '#/components/schemas/_types.aggregations.LinearMovingAverageAggregation'
      - $ref: '#/components/schemas/_types.aggregations.SimpleMovingAverageAggregation'
      - $ref: '#/components/schemas/_types.aggregations.EwmaMovingAverageAggregation'
      - $ref: '#/components/schemas/_types.aggregations.HoltMovingAverageAggregation'
      - $ref: '#/components/schemas/_types.aggregations.HoltWintersMovingAverageAggregation'
    _types.StandardRetriever:
      allOf:
      - $ref: '#/components/schemas/_types.RetrieverBase'
      - type: object
        properties:
          query:
            description: Defines a query to retrieve a set of top documents.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          search_after:
            description: Defines a search after object parameter used for pagination.
            allOf:
            - $ref: '#/components/schemas/_types.SortResults'
          terminate_after:
            description: Maximum number of documents to collect for each shard.
            type: number
          sort:
            description: A sort object that that specifies the order of matching documents.
            allOf:
            - $ref: '#/components/schemas/_types.Sort'
          collapse:
            description: Collapses the top documents by a specified key into a single top document per key.
            allOf:
            - $ref: '#/components/schemas/_global.search._types.FieldCollapse'
    ml._types.PassThroughInferenceUpdateOptions:
      type: object
      properties:
        tokenization:
          description: The tokenization options to update when inferring
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpTokenizationUpdateOptions'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
    _types.RetrieverBase:
      type: object
      properties:
        filter:
          description: Query to filter the documents that can match.
          oneOf:
          - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          - type: array
            items:
              $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
        min_score:
          description: Minimum _score for matching documents. Documents with a lower _score are not included in the top documents.
          type: number
        _name:
          description: Retriever name.
          type: string
    _types.query_dsl.UntypedDistanceFeatureQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQueryBase'
      - type: object
    _types.aggregations.BucketPathAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.Aggregation'
      - type: object
        properties:
          buckets_path:
            description: Path to the buckets that contain one set of values to correlate.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.BucketsPath'
    _types.query_dsl.TextExpansionQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          model_id:
            description: The text expansion NLP model to use
            type: string
          model_text:
            description: The query text
            type: string
          pruning_config:
            description: Token pruning configurations
            x-state: Technical preview; Added in 8.13.0
            allOf:
            - $ref: '#/components/schemas/_types.TokenPruningConfig'
        required:
        - model_id
        - model_text
    _types.aggregations.EwmaModelSettings:
      type: object
      properties:
        alpha:
          type: number
    _types.KnnRetriever:
      allOf:
      - $ref: '#/components/schemas/_types.RetrieverBase'
      - type: object
        properties:
          field:
            description: The name of the vector field to search against.
            type: string
          query_vector:
            description: Query vector. Must have the same number of dimensions as the vector field you are searching against. You must provide a query_vector_builder or query_vector, but not both.
            allOf:
            - $ref: '#/components/schemas/_types.QueryVector'
          query_vector_builder:
            description: Defines a model to build a query vector.
            allOf:
            - $ref: '#/components/schemas/_types.QueryVectorBuilder'
          k:
            description: Number of nearest neighbors to return as top hits.
            type: number
          num_candidates:
            description: Number of nearest neighbor candidates to consider per shard.
            type: number
          visit_percentage:
            description: The percentage of vectors to explore per shard while doing knn search with bbq_disk
            x-state: Generally available; Added in 9.2.0
            type: number
          similarity:
            description: The minimum similarity required for a document to be considered a match.
            type: number
          rescore_vector:
            description: Apply oversampling and rescoring to quantized vectors
            x-state: Generally available; Added in 8.18.0
            allOf:
            - $ref: '#/components/schemas/_types.RescoreVector'
        required:
        - field
        - k
        - num_candidates
    _types.VersionString:
      type: string
    _types.aggregations.MultiTermLookup:
      type: object
      properties:
        field:
          description: A fields from which to retrieve terms.
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        missing:
          description: 'The value to apply to documents that do not have a value.

            By default, documents without a value are ignored.'
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.Missing'
      required:
      - field
    ml._types.ModelPackageConfig:
      type: object
      properties:
        create_time:
          allOf:
          - $ref: '#/components/schemas/_types.EpochTimeUnitMillis'
        description:
          type: string
        inference_config:
          type: object
          additionalProperties:
            type: object
        metadata:
          allOf:
          - $ref: '#/components/schemas/_types.Metadata'
        minimum_version:
          type: string
        model_repository:
          type: string
        model_type:
          type: string
        packaged_model_id:
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        platform_architecture:
          type: string
        prefix_strings:
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelPrefixStrings'
        size:
          allOf:
          - $ref: '#/components/schemas/_types.ByteSize'
        sha256:
          type: string
        tags:
          type: array
          items:
            type: string
        vocabulary_file:
          type: string
      required:
      - packaged_model_id
    _types.ScriptSortType:
      type: string
      enum:
      - string
      - number
      - version
    _types.query_dsl.RangeQueryBase:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          relation:
            description: "Indicates how the range query matches values for `range` fields.\n\nSupported values include:\n  - `within`: Matches documents with a range field value entirely within the query’s range.\n  - `contains`: Matches documents with a range field value that entirely contains the query’s range.\n  - `intersects`: Matches documents with a range field value that intersects the query’s range.\n\n"
            default: intersects
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.RangeRelation'
          gt:
            description: Greater than.
            type: object
          gte:
            description: Greater than or equal to.
            type: object
          lt:
            description: Less than.
            type: object
          lte:
            description: Less than or equal to.
            type: object
    _types.aggregations.SimpleMovingAverageAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase'
      - type: object
        properties:
          model:
            type: string
            enum:
            - simple
          settings:
            allOf:
            - $ref: '#/components/schemas/_types.EmptyObject'
        required:
        - model
        - settings
    _types.query_dsl.SpanFieldMaskingQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          field:
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          query:
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
        required:
        - field
        - query
    _types.aggregations.AggregateOrder:
      oneOf:
      - type: object
        additionalProperties:
          $ref: '#/components/schemas/_types.SortOrder'
        minProperties: 1
        maxProperties: 1
      - type: array
        items:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.SortOrder'
          minProperties: 1
          maxProperties: 1
    _types.aggregations.WeightedAverageAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.Aggregation'
      - type: object
        properties:
          format:
            description: A numeric response formatter.
            type: string
          value:
            description: Configuration for the field that provides the values.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.WeightedAverageValue'
          value_type:
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ValueType'
          weight:
            description: Configuration for the field or script that provides the weights.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.WeightedAverageValue'
    _types.aggregations.EwmaMovingAverageAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase'
      - type: object
        properties:
          model:
            type: string
            enum:
            - ewma
          settings:
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.EwmaModelSettings'
        required:
        - model
        - settings
    ml._types.TrainedModelConfigInput:
      type: object
      properties:
        field_names:
          description: An array of input field names for the model.
          type: array
          items:
            $ref: '#/components/schemas/_types.Field'
      required:
      - field_names
    _types.aggregations.TDigestExecutionHint:
      type: string
      enum:
      - default
      - high_accuracy
    _types.query_dsl.GeoDistanceQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          distance:
            description: 'The radius of the circle centred on the specified location.

              Points which fall into this circle are considered to be matches.'
            allOf:
            - $ref: '#/components/schemas/_types.Distance'
          distance_type:
            description: "How to compute the distance.\nSet to `plane` for a faster calculation that's inaccurate on long distances and close to the poles.\n\nSupported values include:\n  - `arc`: The `arc` calculation is the most accurate.\n  - `plane`: The `plane` calculation is faster but less accurate.\n\n"
            default: '''arc'''
            allOf:
            - $ref: '#/components/schemas/_types.GeoDistanceType'
          validation_method:
            description: "Set to `IGNORE_MALFORMED` to accept geo points with invalid latitude or longitude.\nSet to `COERCE` to also try to infer correct latitude or longitude.\n\nSupported values include:\n  - `coerce`: Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.\n  - `ignore_malformed`: Accept geo points with invalid latitude or longitude.\n  - `strict`\n\n"
            default: '''strict'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.GeoValidationMethod'
          ignore_unmapped:
            description: '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.'
            default: false
            type: boolean
        required:
        - distance
    _types.query_dsl.GeoDecayFunction:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBaseGeoLocationDistance'
      - type: object
    _global.search._types.HighlighterType:
      anyOf:
      - type: string
        enum:
        - plain
        - fvh
        - unified
      - type: string
    _types.query_dsl.SimpleQueryStringFlags:
      description: Query flags can be either a single flag or a combination of flags, e.g. `OR|AND|PREFIX`
      allOf:
      - $ref: '#/components/schemas/_spec_utils.PipeSeparatedFlagsSimpleQueryStringFlag'
    _types.VersionType:
      type: string
      enum:
      - internal
      - external
      - external_gte
    _types.aggregations.ChiSquareHeuristic:
      type: object
      properties:
        background_is_superset:
          description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.
          type: boolean
        include_negatives:
          description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.
          type: boolean
      required:
      - background_is_superset
      - include_negatives
    _types.aggregations.PercentageScoreHeuristic:
      type: object
    _types.query_dsl.HasChildQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          ignore_unmapped:
            description: Indicates whether to ignore an unmapped `type` and not return any documents instead of an error.
            default: false
            type: boolean
          inner_hits:
            description: If defined, each search hit will contain inner hits.
            allOf:
            - $ref: '#/components/schemas/_global.search._types.InnerHits'
          max_children:
            description: '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.'
            type: number
          min_children:
            description: '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.'
            type: number
          query:
            description: 'Query you wish to run on child documents of the `type` field.

              If a child document matches the search, the query returns the parent document.'
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          score_mode:
            description: Indicates how scores for matching child documents affect the root parent document’s relevance score.
            default: '''none'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.ChildScoreMode'
          type:
            description: Name of the child relationship mapped for the `join` field.
            allOf:
            - $ref: '#/components/schemas/_types.RelationName'
        required:
        - query
        - type
    _types.Routing:
      oneOf:
      - type: string
      - type: array
        items:
          type: string
    _types.aggregations.MovingFunctionAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          script:
            description: The script that should be executed on each window of data.
            type: string
          shift:
            description: 'By default, the window consists of the last n values excluding the current bucket.

              Increasing `shift` by 1, moves the starting window position by 1 to the right.'
            default: 0.0
            type: number
          window:
            description: The size of window to "slide" across the histogram.
            type: number
    _types.query_dsl.CombinedFieldsZeroTerms:
      type: string
      enum:
      - none
      - all
    _types.aggregations.MutualInformationHeuristic:
      type: object
      properties:
        background_is_superset:
          description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.
          type: boolean
        include_negatives:
          description: Set to `false` to filter out the terms that appear less often in the subset than in documents outside the subset.
          type: boolean
    ml._types.AdaptiveAllocationsSettings:
      type: object
      properties:
        enabled:
          description: If true, adaptive_allocations is enabled
          type: boolean
        min_number_of_allocations:
          description: 'Specifies the minimum number of allocations to scale to.

            If set, it must be greater than or equal to 0.

            If not defined, the deployment scales to 0.'
          type: number
        max_number_of_allocations:
          description: 'Specifies the maximum number of allocations to scale to.

            If set, it must be greater than or equal to min_number_of_allocations.'
          type: number
      required:
      - enabled
    _types.query_dsl.RankFeatureFunctionLinear:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.RankFeatureFunction'
      - type: object
    _types.query_dsl.ChildScoreMode:
      type: string
      enum:
      - none
      - avg
      - sum
      - max
      - min
    _types.aggregations.CompositeAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          after:
            description: When paginating, use the `after_key` value returned in the previous response to retrieve the next page.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CompositeAggregateKey'
          size:
            description: The number of composite buckets that should be returned.
            default: 10.0
            type: number
          sources:
            description: 'The value sources used to build composite buckets.

              Keys are returned in the order of the `sources` definition.'
            type: array
            items:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/_types.aggregations.CompositeAggregationSource'
              minProperties: 1
              maxProperties: 1
    _types.query_dsl.SpanGapQuery:
      description: Can only be used as a clause in a span_near query.
      type: object
      additionalProperties:
        type: number
      minProperties: 1
      maxProperties: 1
    _types.QueryVectorBuilder:
      type: object
      properties:
        text_embedding:
          allOf:
          - $ref: '#/components/schemas/_types.TextEmbedding'
      minProperties: 1
      maxProperties: 1
    _types.DateFormat:
      type: string
    ml._types.NerInferenceOptions:
      description: Named entity recognition options
      type: object
      properties:
        tokenization:
          description: The tokenization options
          allOf:
          - $ref: '#/components/schemas/ml._types.TokenizationConfigContainer'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        classification_labels:
          description: The token classification labels. Must be IOB formatted tags
          type: array
          items:
            type: string
        vocabulary:
          allOf:
          - $ref: '#/components/schemas/ml._types.Vocabulary'
    _types.Script:
      type: object
      properties:
        source:
          description: The script source.
          allOf:
          - $ref: '#/components/schemas/_types.ScriptSource'
        id:
          description: The `id` for a stored script.
          allOf:
          - $ref: '#/components/schemas/_types.Id'
        params:
          description: 'Specifies any named parameters that are passed into the script as variables.

            Use parameters instead of hard-coded values to decrease compile time.'
          type: object
          additionalProperties:
            type: object
        lang:
          description: "Specifies the language the script is written in.\n\nSupported values include:\n  - `painless`: Painless scripting language, purpose-built for Elasticsearch.\n  - `expression`: Lucene’s expressions language, compiles a JavaScript expression to bytecode.\n  - `mustache`: Mustache templated, used for templates.\n  - `java`: Expert Java API\n\n"
          default: painless
          allOf:
          - $ref: '#/components/schemas/_types.ScriptLanguage'
        options:
          type: object
          additionalProperties:
            type: string
    _types.GeoDistanceType:
      type: string
      enum:
      - arc
      - plane
    _types.DurationLarge:
      description: 'A date histogram interval. Similar to `Duration` with additional units: `w` (week), `M` (month), `q` (quarter) and

        `y` (year)'
      type: string
    _types.aggregations.BucketKsAggregation:
      description: 'A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred

        to as a "K-S test" from now on) against a provided distribution, and the distribution implied

        by the documents counts in the configured sibling aggregation. Specifically, for some metric,

        assuming that the percentile intervals of the metric are known beforehand or have been computed

        by an aggregation, then one would use range aggregation for the sibling to compute the p-value

        of the distribution difference between the metric and the restriction of that metric to a subset

        of the documents. A natural use case is if the sibling aggregation range aggregation nested in a

        terms aggregation, in which case one compares the overall distribution of metric to its restriction

        to each term.'
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketPathAggregation'
      - type: object
        properties:
          alternative:
            description: 'A list of string values indicating which K-S test alternative to calculate. The valid values

              are: "greater", "less", "two_sided". This parameter is key for determining the K-S statistic used

              when calculating the K-S test. Default value is all possible alternative hypotheses.'
            type: array
            items:
              type: string
          fractions:
            description: 'A list of doubles indicating the distribution of the samples with which to compare to the `buckets_path` results.

              In typical usage this is the overall proportion of documents in each bucket, which is compared with the actual

              document proportions in each bucket from the sibling aggregation counts. The default is to assume that overall

              documents are uniformly distributed on these buckets, which they would be if one used equal percentiles of a

              metric to define the bucket end points.'
            type: array
            items:
              type: number
          sampling_method:
            description: 'Indicates the sampling methodology when calculating the K-S test. Note, this is sampling of the returned values.

              This determines the cumulative distribution function (CDF) points used comparing the two samples. Default is

              `upper_tail`, which emphasizes the upper end of the CDF points. Valid options are: `upper_tail`, `uniform`,

              and `lower_tail`.'
            type: string
    _types.aggregations.BucketCorrelationAggregation:
      description: A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketPathAggregation'
      - type: object
        properties:
          function:
            description: The correlation function to execute.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.BucketCorrelationFunction'
        required:
        - function
    _types.aggregations.GeoHashGridAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          bounds:
            description: The bounding box to filter the points in each bucket.
            allOf:
            - $ref: '#/components/schemas/_types.GeoBounds'
          field:
            description: 'Field containing indexed `geo_point` or `geo_shape` values.

              If the field contains an array, `geohash_grid` aggregates all array values.'
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          precision:
            description: The string length of the geohashes used to define cells/buckets in the results.
            default: '5'
            allOf:
            - $ref: '#/components/schemas/_types.GeoHashPrecision'
          shard_size:
            description: '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.'
            type: number
          size:
            description: The maximum number of geohash buckets to return.
            default: 10000.0
            type: number
    _types.aggregations.GlobalAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
    _types.NestedSortValue:
      type: object
      properties:
        filter:
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
        max_children:
          type: number
        nested:
          allOf:
          - $ref: '#/components/schemas/_types.NestedSortValue'
        path:
          allOf:
          - $ref: '#/components/schemas/_types.Field'
      required:
      - path
    ml._types.TokenizationConfigContainer:
      description: Tokenization options stored in inference configuration
      type: object
      properties:
        bert:
          description: Indicates BERT tokenization and its options
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpBertTokenizationConfig'
        bert_ja:
          description: Indicates BERT Japanese tokenization and its options
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpBertTokenizationConfig'
        mpnet:
          description: Indicates MPNET tokenization and its options
          x-state: Generally available; Added in 8.1.0
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpBertTokenizationConfig'
        roberta:
          description: Indicates RoBERTa tokenization and its options
          x-state: Generally available; Added in 8.2.0
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpRobertaTokenizationConfig'
        xlm_roberta:
          allOf:
          - $ref: '#/components/schemas/ml._types.XlmRobertaTokenizationConfig'
      minProperties: 1
      maxProperties: 1
    _types.GeoTile:
      description: A map tile reference, represented as `{zoom}/{x}/{y}`
      type: string
    _types.aggregations.VariableWidthHistogramAggregation:
      type: object
      properties:
        field:
          description: The name of the field.
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        buckets:
          description: The target number of buckets.
          default: 10.0
          type: number
        shard_size:
          description: 'The number of buckets that the coordinating node will request from each shard.

            Defaults to `buckets * 50`.'
          type: number
        initial_buffer:
          description: 'Specifies the number of individual documents that will be stored in memory on a shard before the initial bucketing algorithm is run.

            Defaults to `min(10 * shard_size, 50000)`.'
          type: number
        script:
          allOf:
          - $ref: '#/components/schemas/_types.Script'
    _types.aggregations.MinBucketAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
    _types.query_dsl.IntervalsPrefix:
      type: object
      properties:
        analyzer:
          description: Analyzer used to analyze the `prefix`.
          type: string
        prefix:
          description: Beginning characters of terms you wish to find in the top-level field.
          type: string
        use_field:
          description: 'If specified, match intervals from this field rather than the top-level field.

            The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.'
          allOf:
          - $ref: '#/components/schemas/_types.Field'
      required:
      - prefix
    _types.RescoreVector:
      type: object
      properties:
        oversample:
          description: Applies the specified oversample factor to k on the approximate kNN search
          type: number
      required:
      - oversample
    _types.aggregations.GoogleNormalizedDistanceHeuristic:
      type: object
      properties:
        background_is_superset:
          description: Set to `false` if you defined a custom background filter that represents a different set of documents that you want to compare to.
          type: boolean
    ml._types.TrainedModelPrefixStrings:
      type: object
      properties:
        ingest:
          description: String prepended to input at ingest
          type: string
        search:
          description: String prepended to input at search
          type: string
    _types.Names:
      oneOf:
      - $ref: '#/components/schemas/_types.Name'
      - type: array
        items:
          $ref: '#/components/schemas/_types.Name'
    _types.query_dsl.IntervalsRange:
      type: object
      properties:
        analyzer:
          description: Analyzer used to analyze the `prefix`.
          type: string
        gte:
          description: Lower term, either gte or gt must be provided.
          type: string
        gt:
          description: Lower term, either gte or gt must be provided.
          type: string
        lte:
          description: Upper term, either lte or lt must be provided.
          type: string
        lt:
          description: Upper term, either lte or lt must be provided.
          type: string
        use_field:
          description: 'If specified, match intervals from this field rather than the top-level field.

            The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.'
          allOf:
          - $ref: '#/components/schemas/_types.Field'
    ml._types.TrainedModelDeploymentNodesStats:
      type: object
      properties:
        average_inference_time_ms:
          description: The average time for each inference call to complete on this node.
          allOf:
          - $ref: '#/components/schemas/_types.DurationValueUnitFloatMillis'
        average_inference_time_ms_last_minute:
          allOf:
          - $ref: '#/components/schemas/_types.DurationValueUnitFloatMillis'
        average_inference_time_ms_excluding_cache_hits:
          description: The average time for each inference call to complete on this node, excluding cache
          allOf:
          - $ref: '#/components/schemas/_types.DurationValueUnitFloatMillis'
        error_count:
          description: The number of errors when evaluating the trained model.
          type: number
        inference_count:
          description: The total number of inference calls made against this node for this model.
          type: number
        inference_cache_hit_count:
          type: number
        inference_cache_hit_count_last_minute:
          type: number
        last_access:
          description: The epoch time stamp of the last inference call for the model on this node.
          allOf:
          - $ref: '#/components/schemas/_types.EpochTimeUnitMillis'
        node:
          description: Information pertaining to the node.
          x-state: Generally available
          allOf:
          - $ref: '#/components/schemas/ml._types.DiscoveryNode'
        number_of_allocations:
          description: The number of allocations assigned to this node.
          type: number
        number_of_pending_requests:
          description: The number of inference requests queued to be processed.
          type: number
        peak_throughput_per_minute:
          type: number
        rejected_execution_count:
          description: The number of inference requests that were not processed because the queue was full.
          type: number
        routing_state:
          description: The current routing state and reason for the current routing state for this allocation.
          allOf:
          - $ref: '#/components/schemas/ml._types.TrainedModelAssignmentRoutingStateAndReason'
        start_time:
          description: The epoch timestamp when the allocation started.
          allOf:
          - $ref: '#/components/schemas/_types.EpochTimeUnitMillis'
        threads_per_allocation:
          description: The number of threads used by each allocation during inference.
          type: number
        throughput_last_minute:
          type: number
        timeout_count:
          description: The number of inference requests that timed out before being processed.
          type: number
      required:
      - peak_throughput_per_minute
      - routing_state
      - throughput_last_minute
    _types.query_dsl.RangeRelation:
      type: string
      enum:
      - within
      - contains
      - intersects
    _types.aggregations.AverageBucketAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
    _types.query_dsl.PercolateQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          document:
            description: The source of the document being percolated.
            type: object
          documents:
            description: An array of sources of the documents being percolated.
            type: array
            items:
              type: object
          field:
            description: Field that holds the indexed queries. The field must use the `percolator` mapping type.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          id:
            description: The ID of a stored document to percolate.
            allOf:
            - $ref: '#/components/schemas/_types.Id'
          index:
            description: The index of a stored document to percolate.
            allOf:
            - $ref: '#/components/schemas/_types.IndexName'
          name:
            description: The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified.
            type: string
          preference:
            description: Preference used to fetch document to percolate.
            type: string
          routing:
            description: Routing used to fetch document to percolate.
            allOf:
            - $ref: '#/components/schemas/_types.Routing'
          version:
            description: The expected version of a stored document to percolate.
            allOf:
            - $ref: '#/components/schemas/_types.VersionNumber'
        required:
        - field
    ml._types.TrainedModelAssignmentRoutingTable:
      type: object
      properties:
        reason:
          description: 'The reason for the current state. It is usually populated only when the

            `routing_state` is `failed`.'
          type: string
        routing_state:
          description: "The current routing state.\n\nSupported values include:\n  - `failed`: The allocation attempt failed.\n  - `started`: The trained model is allocated and ready to accept inference requests.\n  - `starting`: The trained model is attempting to allocate on this node; inference requests are not yet accepted.\n  - `stopped`: The trained model is fully deallocated from this node.\n  - `stopping`: The trained model is being deallocated from this node.\n\n"
          allOf:
          - $ref: '#/components/schemas/ml._types.RoutingState'
        current_allocations:
          description: Current number of allocations.
          type: number
        target_allocations:
          description: Target number of allocations.
          type: number
      required:
      - routing_state
      - current_allocations
      - target_allocations
    _types.aggregations.HdrMethod:
      type: object
      properties:
        number_of_significant_value_digits:
          description: Specifies the resolution of values for the histogram in number of significant digits.
          type: number
    _types.GeoHexCell:
      description: A map hex cell (H3) reference
      type: string
    ml._types.NlpTokenizationUpdateOptions:
      type: object
      properties:
        truncate:
          description: Truncate options to apply
          allOf:
          - $ref: '#/components/schemas/ml._types.TokenizationTruncate'
        span:
          description: Span options to apply
          type: number
    _types.DistanceUnit:
      type: string
      enum:
      - in
      - ft
      - yd
      - mi
      - nmi
      - km
      - m
      - cm
      - mm
    _types.aggregations.CategorizeTextAggregation:
      description: 'A multi-bucket aggregation that groups semi-structured text into buckets. Each text

        field is re-analyzed using a custom analyzer. The resulting tokens are then categorized

        creating buckets of similarly formatted text values. This aggregation works best with machine

        generated text like system logs. Only the first 100 analyzed tokens are used to categorize the text.'
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.Aggregation'
      - type: object
        properties:
          field:
            description: The semi-structured text field to categorize.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          max_unique_tokens:
            description: 'The maximum number of unique tokens at any position up to max_matched_tokens. Must be larger than 1.

              Smaller values use less memory and create fewer categories. Larger values will use more memory and

              create narrower categories. Max allowed value is 100.'
            default: 50.0
            type: number
          max_matched_tokens:
            description: 'The maximum number of token positions to match on before attempting to merge categories. Larger

              values will use more memory and create narrower categories. Max allowed value is 100.'
            default: 5.0
            type: number
          similarity_threshold:
            description: 'The minimum percentage of tokens that must match for text to be added to the category bucket. Must

              be between 1 and 100. The larger the value the narrower the categories. Larger values will increase memory

              usage and create narrower categories.'
            default: 50.0
            type: number
          categorization_filters:
            description: 'This property expects an array of regular expressions. The expressions are used to filter out matching

              sequences from the categorization field values. You can use this functionality to fine tune the categorization

              by excluding sequences from consideration when categories are defined. For example, you can exclude SQL

              statements that appear in your log files. This property cannot be used at the same time as categorization_analyzer.

              If you only want to define simple regular expression filters that are applied prior to tokenization, setting

              this property is the easiest method. If you also want to customize the tokenizer or post-tokenization filtering,

              use the categorization_analyzer property instead and include the filters as pattern_replace character filters.'
            type: array
            items:
              type: string
          categorization_analyzer:
            externalDocs:
              url: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-analyze
            description: 'The categorization analyzer specifies how the text is analyzed and tokenized before being categorized.

              The syntax is very similar to that used to define the analyzer in the analyze API. This property

              cannot be used at the same time as `categorization_filters`.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CategorizeTextAnalyzer'
          shard_size:
            description: The number of categorization buckets to return from each shard before merging all the results.
            type: number
          size:
            description: The number of buckets to return.
            default: 10.0
            type: number
          min_doc_count:
            description: The minimum number of documents in a bucket to be returned to the results.
            type: number
          shard_min_doc_count:
            description: The minimum number of documents in a bucket to be returned from the shard before merging.
            type: number
        required:
        - field
    _types.aggregations.ChangePointAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
    _global.search._types.ScriptRescore:
      type: object
      properties:
        script:
          allOf:
          - $ref: '#/components/schemas/_types.Script'
      required:
      - script
    _types.query_dsl.MultiValueMode:
      type: string
      enum:
      - min
      - max
      - avg
      - sum
    ml._types.TrainedModelEntities:
      type: object
      properties:
        class_name:
          type: string
        class_probability:
          type: number
        entity:
          type: string
        start_pos:
          type: number
        end_pos:
          type: number
      required:
      - class_name
      - class_probability
      - entity
      - start_pos
      - end_pos
    _types.query_dsl.MatchPhraseQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          analyzer:
            description: Analyzer used to convert the text in the query value into tokens.
            type: string
          query:
            description: Query terms that are analyzed and turned into a phrase query.
            type: string
          slop:
            description: Maximum number of positions allowed between matching tokens.
            default: 0.0
            type: number
          zero_terms_query:
            description: "Indicates whether no documents are returned if the `analyzer` removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n  - `all`: Returns all documents, similar to a `match_all` query.\n  - `none`: No documents are returned if the `analyzer` removes all tokens.\n\n"
            default: '''none'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.ZeroTermsQuery'
        required:
        - query
    _types.FieldValue:
      description: A field value.
      oneOf:
      - type: number
      - type: number
      - type: string
      - type: boolean
      - type:
        - string
        - 'null'
    _types.aggregations.BucketSortAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.Aggregation'
      - type: object
        properties:
          from:
            description: Buckets in positions prior to `from` will be truncated.
            type: number
          gap_policy:
            description: "The policy to apply when gaps are found in the data.\n\nSupported values include:\n  - `skip`: Treats missing data as if the bucket does not exist. It will skip the bucket and\ncontinue calculating using the next available value.\n  - `insert_zeros`: Replace missing values with a zero (0) and pipeline aggregation computation will proceed as normal.\n  - `keep_values`: Similar to skip, except if the metric provides a non-null, non-NaN value this value is used,\notherwise the empty bucket is skipped.\n\n"
            default: skip
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.GapPolicy'
          size:
            description: 'The number of buckets to return.

              Defaults to all buckets of the parent aggregation.'
            type: number
          sort:
            description: The list of fields to sort on.
            allOf:
            - $ref: '#/components/schemas/_types.Sort'
    ml._types.CommonTokenizationConfig:
      type: object
      properties:
        do_lower_case:
          description: Should the tokenizer lower case the text
          default: false
          type: boolean
        max_sequence_length:
          description: Maximum input sequence length for the model
          default: 512.0
          type: number
        span:
          description: Tokenization spanning options. Special value of -1 indicates no spanning takes place
          default: -1.0
          type: number
        truncate:
          description: Should tokenization input be automatically truncated before sending to the model for inference
          default: first
          allOf:
          - $ref: '#/components/schemas/ml._types.TokenizationTruncate'
        with_special_tokens:
          description: Is tokenization completed with special tokens
          default: true
          type: boolean
    _types.query_dsl.NumericDecayFunction:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.DecayFunctionBasedoubledouble'
      - type: object
    _types.aggregations.MetricAggregationBase:
      type: object
      properties:
        field:
          description: The field on which to run the aggregation.
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        missing:
          description: 'The value to apply to documents that do not have a value.

            By default, documents without a value are ignored.'
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.Missing'
        script:
          allOf:
          - $ref: '#/components/schemas/_types.Script'
    _types.GeoHashPrecision:
      description: A precision that can be expressed as a geohash length between 1 and 12, or a distance measure like "1km", "10m".
      oneOf:
      - type: number
      - type: string
    _types.aggregations.ExtendedBoundsFieldDateMath:
      type: object
      properties:
        max:
          description: Maximum value for the bound.
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.FieldDateMath'
        min:
          description: Minimum value for the bound.
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.FieldDateMath'
    _types.aggregations.MinAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase'
      - type: object
    _types.query_dsl.DecayFunctionBaseDateMathDuration:
      type: object
      properties:
        multi_value_mode:
          description: "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n  - `min`: Distance is the minimum distance.\n  - `max`: Distance is the maximum distance.\n  - `avg`: Distance is the average distance.\n  - `sum`: Distance is the sum of all distances.\n\n"
          default: min
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode'
    _types.aggregations.HistogramAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          extended_bounds:
            description: Enables extending the bounds of the histogram beyond the data itself.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsdouble'
          hard_bounds:
            description: 'Limits the range of buckets in the histogram.

              It is particularly useful in the case of open data ranges that can result in a very large number of buckets.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.ExtendedBoundsdouble'
          field:
            description: The name of the field to aggregate on.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          interval:
            description: 'The interval for the buckets.

              Must be a positive decimal.'
            type: number
          min_doc_count:
            description: 'Only returns buckets that have `min_doc_count` number of documents.

              By default, the response will fill gaps in the histogram with empty buckets.'
            type: number
          missing:
            description: 'The value to apply to documents that do not have a value.

              By default, documents without a value are ignored.'
            type: number
          offset:
            description: '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.'
            type: number
          order:
            description: 'The sort order of the returned buckets.

              By default, the returned buckets are sorted by their key ascending.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.AggregateOrder'
          script:
            allOf:
            - $ref: '#/components/schemas/_types.Script'
          format:
            type: string
          keyed:
            description: If `true`, returns buckets as a hash instead of an array, keyed by the bucket keys.
            default: false
            type: boolean
    _types.query_dsl.NumberRangeQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.RangeQueryBasedouble'
      - type: object
    ml._types.FillMaskInferenceUpdateOptions:
      type: object
      properties:
        num_top_classes:
          description: Specifies the number of top class predictions to return. Defaults to 0.
          type: number
        tokenization:
          description: The tokenization options to update when inferring
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpTokenizationUpdateOptions'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
    _types.query_dsl.Operator:
      type: string
      enum:
      - and
      - AND
      - or
      - OR
    _types.query_dsl.IntervalsRegexp:
      type: object
      properties:
        analyzer:
          description: Analyzer used to analyze the `prefix`.
          type: string
        pattern:
          description: Regex pattern.
          type: string
        use_field:
          description: 'If specified, match intervals from this field rather than the top-level field.

            The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.'
          allOf:
          - $ref: '#/components/schemas/_types.Field'
      required:
      - pattern
    _types.query_dsl.FieldValueFactorModifier:
      type: string
      enum:
      - none
      - log
      - log1p
      - log2p
      - ln
      - ln1p
      - ln2p
      - square
      - sqrt
      - reciprocal
    _types.aggregations.TopMetricsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
        properties:
          metrics:
            description: The fields of the top document to return.
            oneOf:
            - $ref: '#/components/schemas/_types.aggregations.TopMetricsValue'
            - type: array
              items:
                $ref: '#/components/schemas/_types.aggregations.TopMetricsValue'
          size:
            description: The number of top documents from which to return metrics.
            default: 1.0
            type: number
          sort:
            description: The sort order of the documents.
            allOf:
            - $ref: '#/components/schemas/_types.Sort'
    _types.aggregations.HoltLinearModelSettings:
      type: object
      properties:
        alpha:
          type: number
        beta:
          type: number
    _types.RRFRetrieverEntry:
      description: Either a direct RetrieverContainer (backward compatible) or an RRFRetrieverComponent with weight.
      oneOf:
      - $ref: '#/components/schemas/_types.RetrieverContainer'
      - $ref: '#/components/schemas/_types.RRFRetrieverComponent'
    _types.DateTime:
      description: 'A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a

        number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string

        representation.'
      oneOf:
      - type: string
      - $ref: '#/components/schemas/_types.EpochTimeUnitMillis'
    _types.aggregations.SamplerAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          shard_size:
            description: Limits how many top-scoring documents are collected in the sample processed on each shard.
            default: 100.0
            type: number
    _types.aggregations.PercentilesAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase'
      - type: object
        properties:
          keyed:
            description: 'By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.

              Set to `false` to disable this behavior.'
            default: true
            type: boolean
          percents:
            description: The percentiles to calculate.
            oneOf:
            - type: number
            - type: array
              items:
                type: number
          hdr:
            description: Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.HdrMethod'
          tdigest:
            description: Sets parameters for the default TDigest algorithm used to calculate percentiles.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TDigest'
    _types.query_dsl.WrapperQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          query:
            description: 'A base64 encoded query.

              The binary data format can be any of JSON, YAML, CBOR or SMILE encodings'
            type: string
        required:
        - query
    _types.query_dsl.MoreLikeThisQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          analyzer:
            externalDocs:
              url: https://www.elastic.co/docs/manage-data/data-store/text-analysis
            description: 'The analyzer that is used to analyze the free form text.

              Defaults to the analyzer associated with the first field in fields.'
            type: string
          boost_terms:
            description: '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).'
            default: 0.0
            type: number
          fail_on_unsupported_field:
            description: Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (`text` or `keyword`).
            default: true
            type: boolean
          fields:
            description: 'A list of fields to fetch and analyze the text from.

              Defaults to the `index.query.default_field` index setting, which has a default value of `*`.'
            type: array
            items:
              $ref: '#/components/schemas/_types.Field'
          include:
            description: Specifies whether the input documents should also be included in the search results returned.
            default: false
            type: boolean
          like:
            description: Specifies free form text and/or a single or multiple documents for which you want to find similar documents.
            oneOf:
            - $ref: '#/components/schemas/_types.query_dsl.Like'
            - type: array
              items:
                $ref: '#/components/schemas/_types.query_dsl.Like'
          max_doc_freq:
            description: The maximum document frequency above which the terms are ignored from the input document.
            type: number
          max_query_terms:
            description: The maximum number of query terms that can be selected.
            default: 25.0
            type: number
          max_word_length:
            description: 'The maximum word length above which the terms are ignored.

              Defaults to unbounded (`0`).'
            default: 0.0
            type: number
          min_doc_freq:
            description: The minimum document frequency below which the terms are ignored from the input document.
            default: 5.0
            type: number
          minimum_should_match:
            description: After the disjunctive query has been formed, this parameter controls the number of terms that must match.
            allOf:
            - $ref: '#/components/schemas/_types.MinimumShouldMatch'
          min_term_freq:
            description: The minimum term frequency below which the terms are ignored from the input document.
            default: 2.0
            type: number
          min_word_length:
            description: The minimum word length below which the terms are ignored.
            default: 0.0
            type: number
          routing:
            allOf:
            - $ref: '#/components/schemas/_types.Routing'
          stop_words:
            description: 'An array of stop words.

              Any word in this set is ignored.'
            allOf:
            - $ref: '#/components/schemas/_types.analysis.StopWords'
          unlike:
            description: Used in combination with `like` to exclude documents that match a set of terms.
            oneOf:
            - $ref: '#/components/schemas/_types.query_dsl.Like'
            - type: array
              items:
                $ref: '#/components/schemas/_types.query_dsl.Like'
          version:
            allOf:
            - $ref: '#/components/schemas/_types.VersionNumber'
          version_type:
            description: "\n\nSupported values include:\n  - `internal`: Use internal versioning that starts at 1 and increments with each update or delete.\n  - `external`: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.\n  - `external_gte`: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document.\nNOTE: The `external_gte` version type is meant for special use cases and should be used with care.\nIf used incorrectly, it can result in loss of data.\n\n"
            default: '''internal'''
            allOf:
            - $ref: '#/components/schemas/_types.VersionType'
        required:
        - like
    _types.query_dsl.BoolQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          filter:
            description: 'The clause (query) must appear in matching documents.

              However, unlike `must`, the score of the query will be ignored.'
            oneOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
            - type: array
              items:
                $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          minimum_should_match:
            description: Specifies the number or percentage of `should` clauses returned documents must match.
            allOf:
            - $ref: '#/components/schemas/_types.MinimumShouldMatch'
          must:
            description: The clause (query) must appear in matching documents and will contribute to the score.
            oneOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
            - type: array
              items:
                $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          must_not:
            description: 'The clause (query) must not appear in the matching documents.

              Because scoring is ignored, a score of `0` is returned for all documents.'
            oneOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
            - type: array
              items:
                $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          should:
            description: The clause (query) should appear in the matching document.
            oneOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
            - type: array
              items:
                $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
    _types.aggregations.ValueCountAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.FormattableMetricAggregation'
      - type: object
    ml._types.TrainedModelConfigMetadata:
      type: object
      properties:
        model_aliases:
          type: array
          items:
            type: string
        feature_importance_baseline:
          description: An object that contains the baseline for feature importance values. For regression analysis, it is a single value. For classification analysis, there is a value for each class.
          type: object
          additionalProperties:
            type: string
        hyperparameters:
          description: List of the available hyperparameters optimized during the fine_parameter_tuning phase as well as specified by the user.
          type: array
          items:
            $ref: '#/components/schemas/ml._types.Hyperparameter'
        total_feature_importance:
          description: An array of the total feature importance for each feature used from the training data set. This array of objects is returned if data frame analytics trained the model and the request includes total_feature_importance in the include request parameter.
          type: array
          items:
            $ref: '#/components/schemas/ml._types.TotalFeatureImportance'
    ml._types.InferenceConfigUpdateContainer:
      type: object
      properties:
        regression:
          description: Regression configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.RegressionInferenceOptions'
        classification:
          description: Classification configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.ClassificationInferenceOptions'
        text_classification:
          description: Text classification configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.TextClassificationInferenceUpdateOptions'
        zero_shot_classification:
          description: Zeroshot classification configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.ZeroShotClassificationInferenceUpdateOptions'
        fill_mask:
          description: Fill mask configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.FillMaskInferenceUpdateOptions'
        ner:
          description: Named entity recognition configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.NerInferenceUpdateOptions'
        pass_through:
          description: Pass through configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.PassThroughInferenceUpdateOptions'
        text_embedding:
          description: Text embedding configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.TextEmbeddingInferenceUpdateOptions'
        text_expansion:
          description: Text expansion configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.TextExpansionInferenceUpdateOptions'
        question_answering:
          description: Question answering configuration for inference
          allOf:
          - $ref: '#/components/schemas/ml._types.QuestionAnsweringInferenceUpdateOptions'
      minProperties: 1
      maxProperties: 1
    _types.aggregations.SumBucketAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
    _types.aggregations.CartesianCentroidAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
    ml._types.Vocabulary:
      type: object
      properties:
        index:
          allOf:
          - $ref: '#/components/schemas/_types.IndexName'
      required:
      - index
    _types.query_dsl.HasParentQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          ignore_unmapped:
            description: '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`.'
            default: false
            type: boolean
          inner_hits:
            description: If defined, each search hit will contain inner hits.
            allOf:
            - $ref: '#/components/schemas/_global.search._types.InnerHits'
          parent_type:
            description: Name of the parent relationship mapped for the `join` field.
            allOf:
            - $ref: '#/components/schemas/_types.RelationName'
          query:
            description: 'Query you wish to run on parent documents of the `parent_type` field.

              If a parent document matches the search, the query returns its child documents.'
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          score:
            description: Indicates whether the relevance score of a matching parent document is aggregated into its child documents.
            default: false
            type: boolean
        required:
        - parent_type
        - query
    _types.query_dsl.QueryStringQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          allow_leading_wildcard:
            description: If `true`, the wildcard characters `*` and `?` are allowed as the first character of the query string.
            default: true
            type: boolean
          analyzer:
            description: Analyzer used to convert text in the query string into tokens.
            type: string
          analyze_wildcard:
            description: If `true`, the query attempts to analyze wildcard terms in the query string.
            default: false
            type: boolean
          auto_generate_synonyms_phrase_query:
            description: If `true`, match phrase queries are automatically created for multi-term synonyms.
            default: true
            type: boolean
          default_field:
            description: 'Default field to search if no field is provided in the query string.

              Supports wildcards (`*`).

              Defaults to the `index.query.default_field` index setting, which has a default value of `*`.'
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          default_operator:
            description: Default boolean logic used to interpret text in the query string if no operators are specified.
            default: '''or'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.Operator'
          enable_position_increments:
            description: If `true`, enable position increments in queries constructed from a `query_string` search.
            default: true
            type: boolean
          escape:
            default: false
            type: boolean
          fields:
            description: Array of fields to search. Supports wildcards (`*`).
            type: array
            items:
              $ref: '#/components/schemas/_types.Field'
          fuzziness:
            description: Maximum edit distance allowed for fuzzy matching.
            allOf:
            - $ref: '#/components/schemas/_types.Fuzziness'
          fuzzy_max_expansions:
            description: Maximum number of terms to which the query expands for fuzzy matching.
            default: 50.0
            type: number
          fuzzy_prefix_length:
            description: Number of beginning characters left unchanged for fuzzy matching.
            default: 0.0
            type: number
          fuzzy_rewrite:
            description: Method used to rewrite the query.
            allOf:
            - $ref: '#/components/schemas/_types.MultiTermQueryRewrite'
          fuzzy_transpositions:
            description: If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
            default: true
            type: boolean
          lenient:
            description: If `true`, format-based errors, such as providing a text value for a numeric field, are ignored.
            default: false
            type: boolean
          max_determinized_states:
            description: Maximum number of automaton states required for the query.
            default: 10000.0
            type: number
          minimum_should_match:
            description: Minimum number of clauses that must match for a document to be returned.
            allOf:
            - $ref: '#/components/schemas/_types.MinimumShouldMatch'
          phrase_slop:
            description: Maximum number of positions allowed between matching tokens for phrases.
            default: 0.0
            type: number
          query:
            description: Query string you wish to parse and use for search.
            type: string
          quote_analyzer:
            description: '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.'
            type: string
          quote_field_suffix:
            description: 'Suffix appended to quoted text in the query string.

              You can use this suffix to use a different analysis method for exact matches.'
            type: string
          rewrite:
            description: Method used to rewrite the query.
            allOf:
            - $ref: '#/components/schemas/_types.MultiTermQueryRewrite'
          tie_breaker:
            description: How to combine the queries generated from the individual search terms in the resulting `dis_max` query.
            type: number
          time_zone:
            description: Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.
            allOf:
            - $ref: '#/components/schemas/_types.TimeZone'
          type:
            description: "Determines how the query matches and scores documents.\n\nSupported values include:\n  - `best_fields`: Finds documents that match any field, but uses the `_score` from the best field.\n  - `most_fields`: Finds documents that match any field and combines the `_score` from each field.\n  - `cross_fields`: Treats fields with the same analyzer as though they were one big field.\nLooks for each word in any field.\n  - `phrase`: Runs a `match_phrase` query on each field and uses the `_score` from the best field.\n  - `phrase_prefix`: Runs a `match_phrase_prefix` query on each field and uses the `_score` from the best field.\n  - `bool_prefix`: Creates a `match_bool_prefix` query on each field and combines the `_score` from each field.\n\n"
            default: '''best_fields'''
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.TextQueryType'
        required:
        - query
    _types.aggregations.StatsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase'
      - type: object
    _types.mapping.RuntimeFieldFetchFields:
      type: object
      properties:
        field:
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        format:
          type: string
      required:
      - field
    ml._types.TotalFeatureImportanceClass:
      type: object
      properties:
        class_name:
          description: The target class value. Could be a string, boolean, or number.
          allOf:
          - $ref: '#/components/schemas/_types.Name'
        importance:
          description: A collection of feature importance statistics related to the training data set for this particular feature.
          type: array
          items:
            $ref: '#/components/schemas/ml._types.TotalFeatureImportanceStatistics'
      required:
      - class_name
      - importance
    _types.DateMath:
      type: string
    ml._types.ZeroShotClassificationInferenceUpdateOptions:
      type: object
      properties:
        tokenization:
          description: The tokenization options to update when inferring
          allOf:
          - $ref: '#/components/schemas/ml._types.NlpTokenizationUpdateOptions'
        results_field:
          description: The field that is added to incoming documents to contain the inference prediction. Defaults to predicted_value.
          type: string
        multi_label:
          description: Update the configured multi label option. Indicates if more than one true label exists. Defaults to the configured value.
          type: boolean
        labels:
          description: The labels to predict.
          type: array
          items:
            type: string
      required:
      - labels
    _types.InnerRetriever:
      type: object
      properties:
        retriever:
          allOf:
          - $ref: '#/components/schemas/_types.RetrieverContainer'
        weight:
          type: number
        normalizer:
          allOf:
          - $ref: '#/components/schemas/_types.ScoreNormalizer'
      required:
      - retriever
      - weight
      - normalizer
    _types.aggregations.CompositeGeoTileGridAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase'
      - type: object
        properties:
          precision:
            type: number
          bounds:
            allOf:
            - $ref: '#/components/schemas/_types.GeoBounds'
    _types.aggregations.CartesianBoundsAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
    _global.search._types.HighlighterEncoder:
      type: string
      enum:
      - default
      - html
    _types.query_dsl.RankFeatureFunction:
      type: object
    _types.query_dsl.SpanNotQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          dist:
            description: '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`.'
            type: number
          exclude:
            description: Span query whose matches must not overlap those returned.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
          include:
            description: Span query whose matches are filtered.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.SpanQuery'
          post:
            description: The number of tokens after the include span that can’t have overlap with the exclude span.
            default: 0.0
            type: number
          pre:
            description: The number of tokens before the include span that can’t have overlap with the exclude span.
            default: 0.0
            type: number
        required:
        - exclude
        - include
    ml._types.PredictedValue:
      oneOf:
      - $ref: '#/components/schemas/_types.ScalarValue'
      - type: array
        items:
          $ref: '#/components/schemas/_types.ScalarValue'
    _types.aggregations.ExtendedStatsBucketAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
        properties:
          sigma:
            description: The number of standard deviations above/below the mean to display.
            type: number
    _types.query_dsl.RegexpQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          case_insensitive:
            description: 'Allows case insensitive matching of the regular expression value with the indexed field values when set to `true`.

              When `false`, case sensitivity of matching depends on the underlying field’s mapping.'
            default: false
            x-state: Generally available; Added in 7.10.0
            type: boolean
          flags:
            description: Enables optional operators for the regular expression.
            type: string
          max_determinized_states:
            description: Maximum number of automaton states required for the query.
            default: 10000.0
            type: number
          rewrite:
            description: Method used to rewrite the query.
            allOf:
            - $ref: '#/components/schemas/_types.MultiTermQueryRewrite'
          value:
            description: Regular expression for terms you wish to find in the provided field.
            type: string
        required:
        - value
    _types.query_dsl.ConstantScoreQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          filter:
            description: 'Filter query you wish to run. Any returned documents must match this query.

              Filter queries do not calculate relevance scores.

              To speed up performance, Elasticsearch automatically caches frequently used filter queries.'
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
        required:
        - filter
    ml._types.InferenceConfigCreateContainer:
      description: Inference configuration provided when storing the model config
      type: object
      properties:
        regression:
          description: Regression configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.RegressionInferenceOptions'
        classification:
          description: Classification configuration for inference.
          allOf:
          - $ref: '#/components/schemas/ml._types.ClassificationInferenceOptions'
        text_classification:
          description: Text classification configuration for inference.
          x-state: Generally available; Added in 8.0.0
          allOf:
          - $ref: '#/components/schemas/ml._types.TextClassificationInferenceOptions'
        zero_shot_classification:
          description: Zeroshot classification configuration for inference.
          x-state: Generally available; Added in 8.0.0
          allOf:
          - $ref: '#/components/schemas/ml._types.ZeroShotClassificationInferenceOptions'
        fill_mask:
          description: Fill mask configuration for inference.
          x-state: Generally available; Added in 8.0.0
          allOf:
          - $ref: '#/components/schemas/ml._types.FillMaskInferenceOptions'
        learning_to_rank:
          allOf:
          - $ref: '#/components/schemas/ml._types.LearningToRankConfig'
        ner:
          description: Named entity recognition configuration for inference.
          x-state: Generally available; Added in 8.0.0
          allOf:
          - $ref: '#/components/schemas/ml._types.NerInferenceOptions'
        pass_through:
          description: Pass through configuration for inference.
          x-state: Generally available; Added in 8.0.0
          allOf:
          - $ref: '#/components/schemas/ml._types.PassThroughInferenceOptions'
        text_embedding:
          description: Text embedding configuration for inference.
          x-state: Generally available; Added in 8.0.0
          allOf:
          - $ref: '#/components/schemas/ml._types.TextEmbeddingInferenceOptions'
        text_expansion:
          description: Text expansion configuration for inference.
          x-state: Generally available; Added in 8.8.0
          allOf:
          - $ref: '#/components/schemas/ml._types.TextExpansionInferenceOptions'
        question_answering:
          description: Question answering configuration for inference.
          x-state: Generally available; Added in 8.3.0
          allOf:
          - $ref: '#/components/schemas/ml._types.QuestionAnsweringInferenceOptions'
      minProperties: 1
      maxProperties: 1
    _types.aggregations.CompositeDateHistogramAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.CompositeAggregationBase'
      - type: object
        properties:
          format:
            type: string
          calendar_interval:
            description: Either `calendar_interval` or `fixed_interval` must be present
            allOf:
            - $ref: '#/components/schemas/_types.DurationLarge'
          fixed_interval:
            description: Either `calendar_interval` or `fixed_interval` must be present
            allOf:
            - $ref: '#/components/schemas/_types.DurationLarge'
          offset:
            allOf:
            - $ref: '#/components/schemas/_types.Duration'
          time_zone:
            allOf:
            - $ref: '#/components/schemas/_types.TimeZone'
    _types.aggregations.AdjacencyMatrixAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          filters:
            description: 'Filters used to create buckets.

              At least one filter is required.'
            type: object
            additionalProperties:
              $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          separator:
            description: Separator used to concatenate filter names. Defaults to &.
            type: string
    _types.aggregations.RangeAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          field:
            description: The date field whose values are use to build ranges.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          missing:
            description: 'The value to apply to documents that do not have a value.

              By default, documents without a value are ignored.'
            type: number
          ranges:
            description: An array of ranges used to bucket documents.
            type: array
            items:
              $ref: '#/components/schemas/_types.aggregations.AggregationRange'
          script:
            allOf:
            - $ref: '#/components/schemas/_types.Script'
          keyed:
            description: Set to `true` to associate a unique string key with each bucket and return the ranges as a hash rather than an array.
            type: boolean
          format:
            type: string
    _types.query_dsl.GeoDistanceFeatureQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.DistanceFeatureQueryBaseGeoLocationDistance'
      - type: object
    _types.query_dsl.DecayFunctionBasedoubledouble:
      type: object
      properties:
        multi_value_mode:
          description: "Determines how the distance is calculated when a field used for computing the decay contains multiple values.\n\nSupported values include:\n  - `min`: Distance is the minimum distance.\n  - `max`: Distance is the maximum distance.\n  - `avg`: Distance is the average distance.\n  - `sum`: Distance is the sum of all distances.\n\n"
          default: min
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.MultiValueMode'
    _types.aggregations.CardinalityExecutionMode:
      type: string
      enum:
      - global_ordinals
      - segment_ordinals
      - direct
      - save_memory_heuristic
      - save_time_heuristic
    _types.query_dsl.PrefixQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          rewrite:
            description: Method used to rewrite the query.
            allOf:
            - $ref: '#/components/schemas/_types.MultiTermQueryRewrite'
          value:
            description: Beginning characters of terms you wish to find in the provided field.
            type: string
          case_insensitive:
            description: 'Allows ASCII case insensitive matching of the value with the indexed field values when set to `true`.

              Default is `false` which means the case sensitivity of matching depends on the underlying field’s mapping.'
            default: false
            x-state: Generally available; Added in 7.10.0
            type: boolean
        required:
        - value
    _types.aggregations.AutoDateHistogramAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          buckets:
            description: The target number of buckets.
            default: 10.0
            type: number
          field:
            description: The field on which to run the aggregation.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          format:
            description: '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.'
            type: string
          minimum_interval:
            description: 'The minimum rounding interval.

              This can make the collection process more efficient, as the aggregation will not attempt to round at any interval lower than `minimum_interval`.'
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.MinimumInterval'
          missing:
            description: 'The value to apply to documents that do not have a value.

              By default, documents without a value are ignored.'
            allOf:
            - $ref: '#/components/schemas/_types.DateTime'
          offset:
            description: Time zone specified as a ISO 8601 UTC offset.
            type: string
          params:
            type: object
            additionalProperties:
              type: object
          script:
            allOf:
            - $ref: '#/components/schemas/_types.Script'
          time_zone:
            description: Time zone ID.
            allOf:
            - $ref: '#/components/schemas/_types.TimeZone'
    _types.query_dsl.WeightedTokensQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          tokens:
            description: The tokens representing this query
            oneOf:
            - type: object
              additionalProperties:
                type: number
            - type: array
              items:
                type: object
                additionalProperties:
                  type: number
          pruning_config:
            description: Token pruning configurations
            allOf:
            - $ref: '#/components/schemas/_types.TokenPruningConfig'
        required:
        - tokens
    ml._types.DiscoveryNode:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/ml._types.DiscoveryNodeContent'
      minProperties: 1
      maxProperties: 1
    _types.query_dsl.TextQueryType:
      type: string
      enum:
      - best_fields
      - most_fields
      - cross_fields
      - phrase
      - phrase_prefix
      - bool_prefix
    _types.aggregations.NormalizeMethod:
      type: string
      enum:
      - rescale_0_1
      - rescale_0_100
      - percent_of_sum
      - mean
      - z-score
      - softmax
    _types.ScriptLanguage:
      anyOf:
      - type: string
        enum:
        - painless
        - expression
        - mustache
        - java
      - type: string
    _types.aggregations.GapPolicy:
      type: string
      enum:
      - skip
      - insert_zeros
      - keep_values
    _types.aggregations.CumulativeCardinalityAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.PipelineAggregationBase'
      - type: object
    _types.aggregations.CalendarInterval:
      type: string
      enum:
      - second
      - 1s
      - minute
      - 1m
      - hour
      - 1h
      - day
      - 1d
      - week
      - 1w
      - month
      - 1M
      - quarter
      - 1q
      - year
      - 1y
    _types.aggregations.HoltWintersType:
      type: string
      enum:
      - add
      - mult
    _types.aggregations.FiltersAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          filters:
            description: Collection of queries from which to build buckets.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.BucketsQueryContainer'
          other_bucket:
            description: Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters.
            type: boolean
          other_bucket_key:
            description: The key with which the other bucket is returned.
            default: _other_
            type: string
          keyed:
            description: 'By default, the named filters aggregation returns the buckets as an object.

              Set to `false` to return the buckets as an array of objects.'
            default: true
            type: boolean
    ml._types.FeatureExtractor:
      allOf:
      - $ref: '#/components/schemas/ml._types.QueryFeatureExtractor'
    _types.query_dsl.IntervalsQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - externalDocs:
          url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-intervals-query
        type: object
        properties:
          all_of:
            description: Returns matches that span a combination of other rules.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.IntervalsAllOf'
          any_of:
            description: Returns intervals produced by any of its sub-rules.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.IntervalsAnyOf'
          fuzzy:
            description: Matches terms that are similar to the provided term, within an edit distance defined by `fuzziness`.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.IntervalsFuzzy'
          match:
            description: Matches analyzed text.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.IntervalsMatch'
          prefix:
            description: Matches terms that start with a specified set of characters.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.IntervalsPrefix'
          range:
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.IntervalsRange'
          regexp:
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.IntervalsRegexp'
          wildcard:
            description: Matches terms using a wildcard pattern.
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.IntervalsWildcard'
        minProperties: 1
        maxProperties: 1
    _types.MinimumShouldMatch:
      description: The minimum number of terms that should match as integer, percentage or range
      oneOf:
      - type: number
      - type: string
    _types.aggregations.HoltWintersMovingAverageAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MovingAverageAggregationBase'
      - type: object
        properties:
          model:
            type: string
            enum:
            - holt_winters
          settings:
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.HoltWintersModelSettings'
        required:
        - model
        - settings
    ml.put_trained_model.Preprocessor:
      type: object
      properties:
        frequency_encoding:
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.FrequencyEncodingPreprocessor'
        one_hot_encoding:
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.OneHotEncodingPreprocessor'
        target_mean_encoding:
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.TargetMeanEncodingPreprocessor'
      minProperties: 1
      maxProperties: 1
    _types.IndexName:
      type: string
    _types.GeoBounds:
      description: 'A geo bounding box. It can be represented in various ways:

        - as 4 top/bottom/left/right coordinates

        - as 2 top_left / bottom_right points

        - as 2 top_right / bottom_left points

        - as a WKT bounding box'
      oneOf:
      - $ref: '#/components/schemas/_types.CoordsGeoBounds'
      - $ref: '#/components/schemas/_types.TopLeftBottomRightGeoBounds'
      - $ref: '#/components/schemas/_types.TopRightBottomLeftGeoBounds'
      - $ref: '#/components/schemas/_types.WktGeoBounds'
    _types.Fields:
      oneOf:
      - $ref: '#/components/schemas/_types.Field'
      - type: array
        items:
          $ref: '#/components/schemas/_types.Field'
    _types.query_dsl.CombinedFieldsQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          fields:
            description: List of fields to search. Field wildcard patterns are allowed. Only `text` fields are supported, and they must all have the same search `analyzer`.
            type: array
            items:
              $ref: '#/components/schemas/_types.Field'
          query:
            description: 'Text to search for in the provided `fields`.

              The `combined_fields` query analyzes the provided text before performing a search.'
            type: string
          auto_generate_synonyms_phrase_query:
            description: If true, match phrase queries are automatically created for multi-term synonyms.
            default: true
            type: boolean
          operator:
            description: Boolean logic used to interpret text in the query value.
            default: or
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.CombinedFieldsOperator'
          minimum_should_match:
            externalDocs:
              url: https://www.elastic.co/docs/reference/query-languages/query-dsl/query-dsl-minimum-should-match
            description: Minimum number of clauses that must match for a document to be returned.
            allOf:
            - $ref: '#/components/schemas/_types.MinimumShouldMatch'
          zero_terms_query:
            description: "Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a `stop` filter.\n\nSupported values include:\n  - `none`: No documents are returned if the analyzer removes all tokens.\n  - `all`: Returns all documents, similar to a `match_all` query.\n\n"
            default: none
            allOf:
            - $ref: '#/components/schemas/_types.query_dsl.CombinedFieldsZeroTerms'
        required:
        - fields
        - query
    _global.search._types.Rescore:
      allOf:
      - type: object
        properties:
          window_size:
            type: number
      - type: object
        properties:
          query:
            allOf:
            - $ref: '#/components/schemas/_global.search._types.RescoreQuery'
          learning_to_rank:
            allOf:
            - $ref: '#/components/schemas/_global.search._types.LearningToRank'
          script:
            allOf:
            - $ref: '#/components/schemas/_global.search._types.ScriptRescore'
        minProperties: 1
        maxProperties: 1
    ml._types.TrainedModelInferenceStats:
      type: object
      properties:
        cache_miss_count:
          description: 'The number of times the model was loaded for inference and was not retrieved from the cache.

            If this number is close to the `inference_count`, the cache is not being appropriately used.

            This can be solved by increasing the cache size or its time-to-live (TTL).

            Refer to general machine learning settings for the appropriate settings.'
          type: number
        failure_count:
          description: The number of failures when using the model for inference.
          type: number
        inference_count:
          description: 'The total number of times the model has been called for inference.

            This is across all inference contexts, including all pipelines.'
          type: number
        missing_all_fields_count:
          description: The number of inference calls where all the training features for the model were missing.
          type: number
        timestamp:
          description: The time when the statistics were last updated.
          allOf:
          - $ref: '#/components/schemas/_types.EpochTimeUnitMillis'
      required:
      - cache_miss_count
      - failure_count
      - inference_count
      - missing_all_fields_count
      - timestamp
    _types.analysis.StopWords:
      description: '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.'
      oneOf:
      - $ref: '#/components/schemas/_types.analysis.StopWordLanguage'
      - type: array
        items:
          type: string
    _types.aggregations.PercentileRanksAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.FormatMetricAggregationBase'
      - type: object
        properties:
          keyed:
            description: 'By default, the aggregation associates a unique string key with each bucket and returns the ranges as a hash rather than an array.

              Set to `false` to disable this behavior.'
            default: true
            type: boolean
          values:
            description: An array of values for which to calculate the percentile ranks.
            oneOf:
            - type: array
              items:
                type: number
            - type:
              - string
              - 'null'
          hdr:
            description: Uses the alternative High Dynamic Range Histogram algorithm to calculate percentile ranks.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.HdrMethod'
          tdigest:
            description: Sets parameters for the default TDigest algorithm used to calculate percentile ranks.
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.TDigest'
    _types.aggregations.GeoCentroidAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
        properties:
          count:
            type: number
          location:
            allOf:
            - $ref: '#/components/schemas/_types.GeoLocation'
    _types.aggregations.SamplerAggregationExecutionHint:
      type: string
      enum:
      - map
      - global_ordinals
      - bytes_hash
    _types.GeoHash:
      type: string
    _types.TextEmbedding:
      type: object
      properties:
        model_id:
          description: 'Model ID is required for all dense_vector fields but

            may be inferred for semantic_text fields'
          x-state: Generally available; Added in 8.18.0
          type: string
        model_text:
          type: string
      required:
      - model_text
    ml.put_trained_model.Ensemble:
      type: object
      properties:
        aggregate_output:
          allOf:
          - $ref: '#/components/schemas/ml.put_trained_model.AggregateOutput'
        classification_labels:
          type: array
          items:
            type: string
        feature_names:
          type: array
          items:
            type: string
        target_type:
          type: string
        trained_models:
          type: array
          items:
            $ref: '#/components/schemas/ml.put_trained_model.TrainedModel'
      required:
      - trained_models
    _types.RelationName:
      type: string
    _types.aggregations.BucketsQueryContainer:
      description: 'Aggregation buckets. By default they are returned as an array, but if the aggregation has keys configured for

        the different buckets, the result is a dictionary.'
      oneOf:
      - type: object
        additionalProperties:
          $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
      - type: array
        items:
          $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
    _types.aggregations.CardinalityAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.MetricAggregationBase'
      - type: object
        properties:
          precision_threshold:
            description: 'A unique count below which counts are expected to be close to accurate.

              This allows to trade memory for accuracy.'
            default: 3000.0
            type: number
          rehash:
            type: boolean
          execution_hint:
            description: "Mechanism by which cardinality aggregations is run.\n\nSupported values include:\n  - `global_ordinals`: Run the aggregation by using global ordinals of the field and resolving those values after finishing a shard.\n  - `segment_ordinals`: Run the aggregation by using segment ordinal values and resolving those values after each segment.\n  - `direct`: Run the aggregation by using field values directly.\n  - `save_memory_heuristic`: Heuristic-based mode, default in Elasticsearch 8.3 and earlier.\n  - `save_time_heuristic`: Heuristic-based mode, default in Elasticsearch 8.4 and later.\n\n"
            allOf:
            - $ref: '#/components/schemas/_types.aggregations.CardinalityExecutionMode'
    ml._types.NlpRobertaTokenizationConfig:
      description: RoBERTa tokenization configuration options
      allOf:
      - $ref: '#/components/schemas/ml._types.CommonTokenizationConfig'
      - type: object
        properties:
          add_prefix_space:
            description: Should the tokenizer prefix input with a space character
            default: false
            type: boolean
    _types.aggregations.FrequentItemSetsField:
      type: object
      properties:
        field:
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        exclude:
          description: 'Values to exclude.

            Can be regular expression strings or arrays of strings of exact terms.'
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.TermsExclude'
        include:
          description: 'Values to include.

            Can be regular expression strings or arrays of strings of exact terms.'
          allOf:
          - $ref: '#/components/schemas/_types.aggregations.TermsInclude'
      required:
      - field
    _types.aggregations.IpPrefixAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          field:
            description: The IP address field to aggregation on. The field mapping type must be `ip`.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          prefix_length:
            description: 'Length of the network prefix. For IPv4 addresses the accepted range is [0, 32].

              For IPv6 addresses the accepted range is [0, 128].'
            type: number
          is_ipv6:
            description: Defines whether the prefix applies to IPv6 addresses.
            default: false
            type: boolean
          append_prefix_length:
            description: Defines whether the prefix length is appended to IP address keys in the response.
            default: false
            type: boolean
          keyed:
            description: Defines whether buckets are returned as a hash rather than an array in the response.
            type: boolean
          min_doc_count:
            description: Minimum number of documents in a bucket for it to be included in the response.
            default: 1.0
            type: number
        required:
        - field
        - prefix_length
    _types.query_dsl.IntervalsMatch:
      type: object
      properties:
        analyzer:
          description: Analyzer used to analyze terms in the query.
          type: string
        max_gaps:
          description: 'Maximum number of positions between the matching terms.

            Terms further apart than this are not considered matches.'
          default: -1.0
          type: number
        ordered:
          description: If `true`, matching terms must appear in their specified order.
          default: false
          type: boolean
        query:
          description: Text you wish to find in the provided field.
          type: string
        use_field:
          description: 'If specified, match intervals from this field rather than the top-level field.

            The `term` is normalized using the search analyzer from this field, unless `analyzer` is specified separately.'
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        filter:
          description: An optional interval filter.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.IntervalsFilter'
      required:
      - query
    _types.Distance:
      type: string
    _global.search._types.SearchRequestBody:
      type: object
      properties:
        aggregations:
          externalDocs:
            url: https://www.elastic.co/docs/explore-analyze/query-filter/aggregations
          description: Defines the aggregations that are run as part of the search request.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.aggregations.AggregationContainer'
        collapse:
          description: Collapses search results the values of the specified field.
          allOf:
          - $ref: '#/components/schemas/_global.search._types.FieldCollapse'
        explain:
          description: If `true`, the request returns detailed information about score computation as part of a hit.
          default: false
          type: boolean
        ext:
          description: Configuration of search extensions defined by Elasticsearch plugins.
          type: object
          additionalProperties:
            type: object
        from:
          description: '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.'
          default: 0.0
          type: number
        highlight:
          externalDocs:
            url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/highlighting
          description: Specifies the highlighter to use for retrieving highlighted snippets from one or more fields in your search results.
          allOf:
          - $ref: '#/components/schemas/_global.search._types.Highlight'
        track_total_hits:
          description: '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.'
          default: '10000'
          allOf:
          - $ref: '#/components/schemas/_global.search._types.TrackHits'
        indices_boost:
          externalDocs:
            url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl#relevance-scores
          description: '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.'
          type: array
          items:
            type: object
            additionalProperties:
              type: number
            minProperties: 1
            maxProperties: 1
        docvalue_fields:
          externalDocs:
            url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#docvalue-fields
          description: '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.'
          type: array
          items:
            $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat'
        knn:
          externalDocs:
            url: https://www.elastic.co/docs/solutions/search/vector/knn#approximate-knn
          description: The approximate kNN search to run.
          x-state: Generally available; Added in 8.4.0
          oneOf:
          - $ref: '#/components/schemas/_types.KnnSearch'
          - type: array
            items:
              $ref: '#/components/schemas/_types.KnnSearch'
        rank:
          description: The Reciprocal Rank Fusion (RRF) to use.
          x-state: Generally available; Added in 8.8.0
          allOf:
          - $ref: '#/components/schemas/_types.RankContainer'
        min_score:
          description: 'The minimum `_score` for matching documents.

            Documents with a lower `_score` are not included in search results or results collected by aggregations.'
          type: number
        post_filter:
          description: 'Use the `post_filter` parameter to filter search results.

            The search hits are filtered after the aggregations are calculated.

            A post filter has no impact on the aggregation results.'
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
        profile:
          description: '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.'
          default: false
          type: boolean
        query:
          externalDocs:
            url: https://www.elastic.co/docs/explore-analyze/query-filter/languages/querydsl
          description: The search definition using the Query DSL.
          allOf:
          - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
        rescore:
          description: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.
          oneOf:
          - $ref: '#/components/schemas/_global.search._types.Rescore'
          - type: array
            items:
              $ref: '#/components/schemas/_global.search._types.Rescore'
        retriever:
          externalDocs:
            url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrievers
          description: 'A retriever is a specification to describe top documents returned from a search.

            A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.'
          x-state: Generally available; Added in 8.14.0
          allOf:
          - $ref: '#/components/schemas/_types.RetrieverContainer'
        script_fields:
          description: Retrieve a script evaluation (based on different fields) for each hit.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/_types.ScriptField'
        search_after:
          description: Used to retrieve the next page of hits using a set of sort values from the previous page.
          allOf:
          - $ref: '#/components/schemas/_types.SortResults'
        size:
          description: '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.'
          default: 10.0
          type: number
        slice:
          description: Split a scrolled search into multiple slices that can be consumed independently.
          allOf:
          - $ref: '#/components/schemas/_types.SlicedScroll'
        sort:
          externalDocs:
            url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/sort-search-results
          description: A comma-separated list of <field>:<direction> pairs.
          allOf:
          - $ref: '#/components/schemas/_types.Sort'
        _source:
          externalDocs:
            url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#source-filtering
          description: 'The source fields that are returned for matching documents.

            These fields are returned in the `hits._source` property of the search response.

            If the `stored_fields` property is specified, the `_source` property defaults to `false`.

            Otherwise, it defaults to `true`.'
          allOf:
          - $ref: '#/components/schemas/_global.search._types.SourceConfig'
        fields:
          description: 'An array of wildcard (`*`) field patterns.

            The request returns values for field names matching these patterns in the `hits.fields` property of the response.'
          type: array
          items:
            $ref: '#/components/schemas/_types.query_dsl.FieldAndFormat'
        suggest:
          description: Defines a suggester that provides similar looking terms based on a provided text.
          allOf:
          - $ref: '#/components/schemas/_global.search._types.Suggester'
        terminate_after:
          description: '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.'
          default: 0.0
          type: number
        timeout:
          description: '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.'
          type: string
        track_scores:
          description: If `true`, calculate and return document scores, even if the scores are not used for sorting.
          default: false
          type: boolean
        version:
          description: If `true`, the request returns the document version as part of a hit.
          default: false
          type: boolean
        seq_no_primary_term:
          externalDocs:
            url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/optimistic-concurrency-control
          description: If `true`, the request returns sequence number and primary term of the last modification of each hit.
          type: boolean
        stored_fields:
          externalDocs:
            url: https://www.elastic.co/docs/reference/elasticsearch/rest-apis/retrieve-selected-fields#stored-fields
          description: 'A comma-separated list of stored fields to return as part of a hit.

            If no fields are specified, no stored fields are included in the response.

            If this field is specified, the `_source` property defaults to `false`.

            You can pass `_source: true` to return both source fields and stored fields in the search response.'
          allOf:
          - $ref: '#/components/schemas/_types.Fields'
        pit:
          description: 'Limit the search to a point in time (PIT).

            If you provide a PIT, you cannot specify an `<index>` in the request path.'
          allOf:
          - $ref: '#/components/schemas/_global.search._types.PointInTimeReference'
        runtime_mappings:
          externalDocs:
            url: https://www.elastic.co/docs/manage-data/data-store/mapping/define-runtime-fields-in-search-request
          description: 'One or more runtime fields in the search request.

            These fields take precedence over mapped fields with the same name.'
          allOf:
          - $ref: '#/components/schemas/_types.mapping.RuntimeFields'
        stats:
          description: '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.'
          type: array
          items:
            type: string
    _types.query_dsl.SpanTermQuery:
      allOf:
      - $ref: '#/components/schemas/_types.query_dsl.QueryBase'
      - type: object
        properties:
          value:
            allOf:
            - $ref: '#/components/schemas/_types.FieldValue'
        required:
        - value
    _types.aggregations.GeohexGridAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          field:
            description: 'Field containing indexed `geo_point` or `geo_shape` values.

              If the field contains an array, `geohex_grid` aggregates all array values.'
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          precision:
            description: 'Integer zoom of the key used to defined cells or buckets

              in the results. Value should be between 0-15.'
            default: 6.0
            type: number
          bounds:
            description: Bounding box used to filter the geo-points in each bucket.
            allOf:
            - $ref: '#/components/schemas/_types.GeoBounds'
          size:
            description: Maximum number of buckets to return.
            default: 10000.0
            type: number
          shard_size:
            description: Number of buckets returned from each shard.
            type: number
        required:
        - field
    _global.search._types.TrackHits:
      description: '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.'
      oneOf:
      - type: boolean
      - type: number
    _types.KnnSearch:
      type: object
      properties:
        field:
          description: The name of the vector field to search against
          allOf:
          - $ref: '#/components/schemas/_types.Field'
        query_vector:
          description: The query vector
          allOf:
          - $ref: '#/components/schemas/_types.QueryVector'
        query_vector_builder:
          description: The query vector builder. You must provide a query_vector_builder or query_vector, but not both.
          allOf:
          - $ref: '#/components/schemas/_types.QueryVectorBuilder'
        k:
          description: The final number of nearest neighbors to return as top hits
          type: number
        num_candidates:
          description: The number of nearest neighbor candidates to consider per shard
          type: number
        visit_percentage:
          description: The percentage of vectors to explore per shard while doing knn search with bbq_disk
          x-state: Generally available; Added in 9.2.0
          type: number
        boost:
          description: Boost value to apply to kNN scores
          type: number
        filter:
          description: Filters for the kNN search query
          oneOf:
          - $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
          - type: array
            items:
              $ref: '#/components/schemas/_types.query_dsl.QueryContainer'
        similarity:
          description: The minimum similarity for a vector to be considered a match
          type: number
        inner_hits:
          description: If defined, each search hit will contain inner hits.
          allOf:
          - $ref: '#/components/schemas/_global.search._types.InnerHits'
        rescore_vector:
          description: Apply oversampling and rescoring to quantized vectors
          x-state: Generally available; Added in 8.18.0
          allOf:
          - $ref: '#/components/schemas/_types.RescoreVector'
        _name:
          type: string
      required:
      - field
    _types.aggregations.ParentAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          type:
            description: The child type that should be selected.
            allOf:
            - $ref: '#/components/schemas/_types.RelationName'
    _types.aggregations.ChildrenAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          type:
            description: The child type that should be selected.
            allOf:
            - $ref: '#/components/schemas/_types.RelationName'
    _types.aggregations.RandomSamplerAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          probability:
            description: 'The probability that a document will be included in the aggregated data.

              Must be greater than 0, less than 0.5, or exactly 1.

              The lower the probability, the fewer documents are matched.'
            type: number
          seed:
            description: 'The seed to generate the random sampling of documents.

              When a seed is provided, the random subset of documents is the same between calls.'
            type: number
          shard_seed:
            description: When combined with seed, setting shard_seed ensures 100% consistent sampling over shards where data is exactly the same.
            x-state: Generally available; Added in 8.14.0
            type: number
        required:
        - probability
    _types.aggregations.GeoDistanceAggregation:
      allOf:
      - $ref: '#/components/schemas/_types.aggregations.BucketAggregationBase'
      - type: object
        properties:
          distance_type:
            description: "The distance calculation type.\n\nSupported values include:\n  - `arc`: The `arc` calculation is the most accurate.\n  - `plane`: The `plane` calculation is faster but less accurate.\n\n"
            default: arc
            allOf:
            - $ref: '#/components/schemas/_types.GeoDistanceType'
          field:
            description: A field of type `geo_point` used to evaluate the distance.
            allOf:
            - $ref: '#/components/schemas/_types.Field'
          origin:
            description: The origin  used to evaluate the distance.
            allOf:
            - $ref: '#/components/schemas/_types.GeoLocation'
          ranges:
            description: An array of ranges used to bucket documents.
            type: array
            items:
              $ref: '#/components/schemas/_types.aggregations.AggregationRange'
          unit:
            description: The distance unit.
            default: m
            allOf:
            - $ref: '#/components/schemas/_types.DistanceUnit'
    _types.aggregations.ExtendedBoundsdouble:
      type: object
      properties:
        max:
          description: Maximum value for the bound.
          type: number
        min:
          description: Minimum value for the bound.
          type: number
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: "Elasticsearch APIs support key-based authentication.\nYou must create an API key and use the encoded value in the request header.\nFor example:\n\n```\ncurl -X GET \"${ES_URL}/_cat/indices?v=true\" \\\n  -H \"Authorization: ApiKey ${API_KEY}\"\n```\n\nTo get API keys, use the `/_security/api_key` APIs."
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Elasticsearch APIs support the use of bearer tokens in the `Authorization` HTTP header to authenticate with the API.

        For examples, refer to [Token-based authentication services](https://www.elastic.co/docs/deploy-manage/users-roles/cluster-or-deployment-auth/token-based-authentication-services)'
x-tagGroups:
- name: AI & Machine Learning
  tags:
  - analytics
  - graph
  - inference
  - ml
  - ml anomaly
  - ml data frame
  - ml trained model
  - query_rules
  - text_structure
- name: Cluster Management
  tags:
  - ccr
  - cluster
  - connector
  - data stream
  - ilm
  - indices
  - rollup
  - script
  - search_application
  - searchable_snapshots
  - slm
  - snapshot
- name: Data Processing
  tags:
  - enrich
  - fleet
  - ingest
  - logstash
  - synonyms
  - transform
- name: Information & Monitoring
  tags:
  - cat
  - features
  - health_report
  - info
  - license
  - migration
  - tasks
  - watcher
  - xpack
- name: Search & Document APIs
  tags:
  - document
  - eql
  - esql
  - search
  - sql
- name: Security
  tags:
  - security