Data Structures

There are three main data structures in NBoost, and they are all dictionaries: the request, response, and config.


  "method": "(str) the http method",
  "version": "(str) the http version",
  "headers": "(dict) the dictionary of http headers",
  "url":  { 
    "scheme": "(str) URL scheme specifier",
    "netloc": "(str) network location part",
    "path": "(str) hierarchical path",
    "params": "(str) parameters for last path element",
    "query": "(dict) query parameters",
    "fragment": "(str) fragment identifier"
  "body": {
    "nboost": "(dict) Configures NBoost at runtime. The same as the config.",
    "...other keys": "(dict) the rest of the body to send to the upstream server (e.g. Elasticsearch)"

The url is in the form of scheme://netloc/path;parameters?query#fragment, but is decomposed into a dictionary, as noted above.


  "status": "(int) the status code of the response message",
  "headers": "(dict) the dictionary of http headers",
  "body": {
    "nboost": "(dict) NBoost specific metadata, plugin data, etc..."


  "delim": "(str) the deliminator to concatenate multiple queries into a single query",
  "query_path": "(str) the jsonpath in the request to find the query",
  "topk_path": "(str) the jsonpath to find the number of requested results",
  "choices_path":  "(str) the jsonpath to find the array of choices to reorder",
  "cvalues_path": "(str) the jsonpath to find the string values of the choices",
  "cids_path": "(str) the jsonpath to find the ids of the choices (for benchmarking)",
  "search_path": "(str) the route to capture for reranking search results",
  "default_topk": "(int) the default number of results to return if the topk_path is not found"