PreviewBoosting

Properties to receive on Boosting creation

  • boost
    Type: array object[] · Boost
    required

    The items of the boosting rule.

    • field
      Type: string · Field
      required

      The boosting field of the rule.

    • option
      Type: string · Optionenum
      required

      The boosting option of the field.

      values
      • contains
      • not_contain
      • is
      • is_not
      • regex
      • ends_with
      • starts_with
    • query
      Type: string · Query
      required

      The boosting query of the field.

    • action
      Type: string · Actionenum

      The boosting action of the field.

      values
      • pin
      • bury
      • remove
    • pin_position
      Type: integer · Pin Position
      greater than:  
      0
      min:  
      1

      This field is a 1-based integer to describe the position. This field is only used when action is "pin".

  • boost_match_type
    Type: string · Boost Match Typeenum
    required

    Type of the query. Please fill this field with any or all.

    values
    • any
    • all
  • position
    Type: array integer[] · Position
    required

    The position of the boosting rule should occur.

  • query_option
    Type: string · Query Optionenum
    required

    The options of the query. Please fill this field with contains, not_contain, is, and is_not value.

    values
    • contains
    • not_contain
    • is
    • is_not
    • regex
    • ends_with
    • starts_with
  • boosting_tags
    Type: array string[] · Boosting Tags

    The comma-separated boosting tags.

  • filter_query
    Type: array object[] · Filter Query

    The filter queries of the boosting rule.

    • option
      enum
      const:  
      overlap_with
      required

      The filter query option of the boosting rule.

      values
      • overlap_with
    • query
      Type: string · Query
      required

      The filter query of the boosting rule.

  • json_asset
    Type: string · Json Asset

    The boosting json asset.

  • queries
    Type: array string[] · Queries

    Multiple query of the boosting rule.

  • query
    Type: string · Query

    The boosting rule query.