rest-api-spec.api.rank_eval.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

Elasticsearch subproject :rest-api-spec

There is a newer version: 8.17.0

{
  "rank_eval":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html",
      "description":"Allows to evaluate the quality of ranked search results over a set of typical search queries"
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"],
      "content_type": ["application/json"]
    },
    "url":{
      "paths":[
        {
          "path":"/_rank_eval",
          "methods":[
            "GET",
            "POST"
          ]
        },
        {
          "path":"/{index}/_rank_eval",
          "methods":[
            "GET",
            "POST"
          ],
          "parts":{
            "index":{
              "type":"list",
              "description":"A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices"
            }
          }
        }
      ]
    },
    "params":{
      "ignore_unavailable":{
        "type":"boolean",
        "description":"Whether specified concrete indices should be ignored when unavailable (missing or closed)"
      },
      "allow_no_indices":{
        "type":"boolean",
        "description":"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
      },
      "expand_wildcards":{
        "type":"enum",
        "options":[
          "open",
          "closed",
          "hidden",
          "none",
          "all"
        ],
        "default":"open",
        "description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
      },
      "search_type":{
        "type":"enum",
        "options":[
          "query_then_fetch",
          "dfs_query_then_fetch"
        ],
        "description":"Search operation type"
      }
    },
    "body":{
      "description":"The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.",
      "required":true
    }
  }
}