Product Selector

Fusion 5.12
    Fusion 5.12

    Phrase 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.

    Phrase

    Phrase detection identifies phrases in your signals so that results with matching phrases can be boosted. This helps compensate for queries where phrases are not distinguished with quotation marks. For example, the query ipad case is rewritten as “ipad case”~10^2, meaning if ipad and case appear within 10 terms (whitespace-delimited tokens) of each other, then boost the result by a factor of 2.

    Phrases are applied in the Text Tagger stage of the query pipeline.

    General information

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

    • Required parameter is: 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 Schema

    type

    type

    string

    properties

    confidence

        "confidence": {
          "type": "number",
          "title": "Confidence",
          "description": "Confidence score from the phrase job.",
          "default": 1.0
        }

    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

        "surface_form": {
          "type": "string",
          "title": "Surface Form",
          "description": "The phrase itself"
        }

    phrase_count

        "phrase_count": {
          "type": "integer",
          "title": "Phrase Count",
          "description": "Denotes how many times this phrase was found in the source."
        }

    word_count

        "word_count": {
          "type": "integer",
          "title": "Word Count",
          "description": "Indicates how many words are included in the phrase."
        }

    boost

        "boost": {
          "type": "number",
          "title": "Boost Factor",
          "description": "The factor to use to boost this phrase in matching queries."
        }

    slop

        "slop": {
          "type": "integer",
          "title": "Slop Factor",
          "description": "Phrase slop"
        }

    type

    Required

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

    doc_type

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

    additionalProperties

    additionalProperties

    "additionalProperties": true