Product Selector

Fusion 5.9
    Fusion 5.9

    Remove Words Query Rewrite API ConfigurationsManaged Fusion Query Rewrite APIs

    Table of Contents

    This query rewrite configuration is used in the Query Rewrite API.

    For a complete list of rule and rewrite types in the Query Rewrite API, see Query Rewrite API Configurations.

    For more information, view the API specification.

    Remove Words

    Use a Remove Words query rewrite to remove particular phrases from queries. Unlike other rewrites, Remove Words rules are entered manually and aren’t generated by a job.

    You can create a Remove Words query rewrite to remove words from a query. This query rewrite is helpful when a word in the search query does not add value to the search results.

    For example, you can rewrite a search query for case study examples to remove examples and then display results for case study.

    General information

    • Endpoint: https://EXAMPLE_COMPANY.b.lucidworks.cloud/api/apps/APP_NAME/query-rewrite/schema/RULE_TYPE

    • Required parameters are:

      • surface_form

      • trigger_phrase_ss

      • type

    • The values for the hints parameter include:

      • hidden: Do not display in the Fusion UI, but can be read and written in the schema.

      • readonly: Cannot be set by the user. If attempted, an error is generated and the operation fails.

    Parameter Schems

    type

    type

    string

    properties

    id

    		 
        "id": {
      "type": "string",
      "title": "ID",
      "description": "The ID for this Rule. Used in the API to reference this query rewrite rule. Allowed characters: a-z, A-Z, 0-9, dash (-) and underscore (_)",
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9_\\-]+$"
    }

    source

    		 
        "source": {
      "type": "string",
      "title": "Source",
      "description": "The source for this query rewrite rule, such as a Spark Job.",
      "hints": [
        "hidden"
      ]
    }

    sourceType

    		 
        "sourceType": {
      "type": "string",
      "title": "Source Type",
      "description": "Source type",
      "hints": [
        "hidden"
      ]
    }

    createdOn

    		 
        "createdOn": {
      "type": "string",
      "title": "Created Date/Time",
      "description": "Date/Time this rule was created.",
      "format": "date-time"
    }

    updatedOn

    		 
        "updatedOn": {
      "type": "string",
      "title": "Updated Date/Time",
      "description": "Date/Time this rule was last updated.",
      "format": "date-time"
    }

    reviewer

    		 
        "reviewer": {
      "type": "string",
      "title": "Reviewer",
      "description": "Who reviewed this rewrite rule.",
      "hints": [
        "hidden"
      ]
    }

    reviewedOn

    		 
        "reviewedOn": {
      "type": "string",
      "title": "Reviewed Date/Time",
      "description": "Date/Time this rule was last reviewed.",
      "hints": [
        "hidden"
      ],
      "format": "date-time"
    }

    review

    		 
        "review": {
      "type": "string",
      "title": "Review",
      "enum": [
        "approved",
        "denied"
      ],
      "default": "approved",
      "hints": [
        "readonly"
      ]
    }

    deployed

    		 
        "deployed": {
      "type": "boolean",
      "title": "Deployed Flag",
      "description": "Flag to indicate if this rewrite rule has been deployed.",
      "hints": [
        "hidden"
      ]
    }

    tags

    		 
        "tags": {
      "type": "array",
      "title": "Tags",
      "description": "Conditional tags to restrict the triggering of this query rewrite rule.",
      "items": {
        "type": "string"
      }
    }

    surface_form

    Required

    		 
        "surface_form": {
      "type": "string",
      "title": "Phrase to Remove",
      "description": "Phrase to remove from the query when it contains any of the trigger phrases."
    }

    confidence

    		 
        "confidence": {
      "type": "number",
      "title": "Confidence"
    }

    removeid_s

    		 
        "removeid_s": {
      "type": "string",
      "title": "Remove ID",
      "description": "If this is a trigger doc, holds the ID of the 'base' rewrite doc this is for.",
      "hints": [
        "hidden",
        "readonly"
      ]
    }

    triggerdoc_b

    		 
        "triggerdoc_b": {
      "type": "boolean",
      "title": "Is Trigger Doc",
      "description": "True if this is a trigger doc tied to a particular 'base' rewrite doc (identified by the removeId field).",
      "hints": [
        "hidden",
        "readonly"
      ]
    }

    trigger_phrase_ss

    Required

    		 
        "trigger_phrase_ss": {
      "type": "array",
      "title": "Trigger Phrases",
      "description": "The phrase to remove will be removed from the query when the query also contains any of these phrases.",
      "items": {
        "type": "string"
      }
    }

    type

    Required

    		 
        "type": {
      "type": "string",
      "title": "Type",
      "enum": [
        "removeWords"
      ],
      "default": "removeWords",
      "hints": [
        "readonly"
      ]
    }

    doc_type

    		 
        "doc_type": {
      "type": "string",
      "title": "Doc Type",
      "enum": [
        "query_rewrite"
      ],
      "default": "query_rewrite",
      "hints": [
        "readonly"
      ]
    }
  }

    additionalProperties

    additionalProperties

    		 
    "additionalProperties": true