Tail Query Rewrite API Configurations

On this page

Tail
General information

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.

Tail

Head/tail analysis is:

Also known as the Underperforming Query Rewriting feature
Uses signals data to identify underperforming queries
Suggests improved queries that could produce better conversion rates

When an incoming query contains a matching underperforming query, the original query is replaced by an improved query.

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.

Parameters and schemas

type

string = properties

Hide child attributes

        {
          "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

Hide child attributes

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

sourceType

Hide child attributes

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

createdOn

Hide child attributes

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

updatedOn

Hide child attributes

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

reviewer

Hide child attributes

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

reviewedOn

Hide child attributes

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

review

Hide child attributes

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

deployed

Hide child attributes

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

tags

Hide child attributes

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

surface_form

Hide child attributes

        {
          "surface_form": {
            "type": "string",
            "title": "Tail Query"
          }
        }

confidence

Hide child attributes

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

output

Hide child attributes

        {
          "output": {
            "type": "array",
            "title": "Improved Query",
            "items": { "type": "string" }
          }
        }

type</strong><br/><strong>Required

Hide child attributes

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

doc_type

Hide child attributes

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

additionalProperties

Hide child attributes

        {
          "additionalProperties": true
        }

Synonym Query Rewrite API Configurations Custom Rules API

UI tour

Index data

Query data

Metrics and analytics

Improve your queries

Administration

Developer documentation

Machine learning

Neural Hybrid Search

Release notes

FAQs

Tail

General information

UI tour

Index data

Query data

Metrics and analytics

Improve your queries

Administration

Developer documentation

Machine learning

Neural Hybrid Search

Release notes

FAQs

​Tail

​General information

Tail

General information