binning-set

Creates a specific set of refinements/bins

Description

A binning-set will create a set of bins from the input data, based on the values resulting from the evaluation of a specified XPath (the select attribute). A binning-set can either specify that each unique value be listed in the set (this is the default behavior), or may specify a set of numerical binning-ranges for the values to sorted into.

Attributes

  • select (Text) - An XPath expression. This expression will be evaluated for each document in the result set. Variables are defined and can be used to refer to contents that have been fast-indexed.
  • label (Text) - A label that describes this entire binning set. If this is not specified, no parent bin node will be included in the output, grouping these bins together.
  • other-ndocs (Integer) - The number of values that did not fit into the specified ranges, if this binning-set contains binning-ranges tags, or the number of values that evaluated to empty string otherwise.
  • bin-label-xpath (Text) - An XPath which is evaluated to define a label for a bin. The XPath is evaluated when the bin is created, with the first document added to the bin.
  • display-type (Text)
  • bs-id (Text) - An identifier used for merging multiple different binning outputs.
  • max-bins (Integer default: 100) - The maximum number of bins to return for this binning set. A value of -1 will always allow all bins to be output.
  • disable-bin-pruning (May only be: disable-bin-pruning) - Flag indicating if the entire binning XML should be outputted for multi-level binning sets or trees.
  • n-total-bins (Integer) - The number of bins generated by this binning-set.
  • n-output-bins (Integer) - The number of bins output from this binning-set.
  • ndocs-not-output (Integer) - The number of documents that were binned, but whose bins were skipped because the maximum number of bins was reached.
  • ss (Text) - Added in the output by the Watson™ Explorer software. The state tokens to add to the current state, if the user were to click on a bin in this set.
  • alpha (May only be: alpha) - Sort the bins in this binning set alphabetically instead of by size.
  • remove-state (Text) - The binning state that needs to be passed back to emulate removing this binning as a refinement.
  • restricted-by (Any of: all-selections, other-selections default: all-selections) - Determines which bins will be included in this binning-set.
    • all-selections: Documents must match the binning selection from all binning-sets in order for the document's values to be included as bins.
    • other-selections: Documents must match the binning selection from all binning-sets except this binning-set in order for the document's values to be included as bins. This is the same as "all-selections" when this binning-set is not selected.
  • logic (Any of: and, or default: and) - Determines how this binning-set combines multiple binning-states.
    • and: Documents must match all binning-states to be returned.
    • or: Documents must match at least one binning-state to be returned.

Children

  • Use these in the listed order. The sequence may not repeat.
    • scope: (Exactly 1) - Variable scope
    • Use these in the listed order. The sequence may not repeat.
      • binning-set: (Zero or more) - Creates a specific set of refinements/bins
      • binning-range: (Zero or more) - Specifies a range of numeric values that should be gathered together in the same refinement/bin
      • binning-tree: (Zero or more) - Indicates hierarchical content in a binning-set
      • binning-calculation: (Zero or more) - Specify a calculation that needs to be done on the set of values.
      • bin: (Zero or more) - An internal bin of the full binning set