Response Value Rule API Configurations

This rule type 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.

Response Value

The Response Value action sends an arbitrary value to the frontend or pipeline, which the frontend of pipeline can use to perform another action. The Response Value action can be combined with other actions within the same rule. For example, an e-commerce website may use the response value action to display an advertisement.

General information

Endpoint: https://EXAMPLE_COMPANY.b.lucidworks.cloud/api/apps/APP_NAME/query-rewrite/schema/RULE_TYPE
Required parameters are:
- name
- 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

Show 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

Show child attributes

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

sourceType

Show child attributes

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

createdOn

Show child attributes

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

updatedOn

Show child attributes

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

reviewer

Show child attributes

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

reviewedOn

Show child attributes

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

review

Show child attributes

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

deployed

Show child attributes

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

tags

Show child attributes

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

name Required

Show child attributes

        {
          "name": {
            "type": "string",
            "title": "Name",
            "description": "User-friendly name for this rule."
          }
        }

description

Show child attributes

        {
          "description": {
            "type": "string",
            "title": "Description",
            "description": "Short description of what this rule does."
          }
        }

enabled

Show child attributes

        {
          "enabled": {
            "type": "boolean",
            "title": "Enabled",
            "description": "Set to false to disable this rule.",
            "default": true
          }
        }

matching

Show child attributes

        {
          "matching": {
            "type": "string",
            "title": "Match Query Using",
            "description": "Defines how the specified search terms will be compared to the user's query to determine whether this rule applies. 'keywords' means the query must match the keywords of the search terms value exactly. 'phrase' means the search query must contain one of the search terms values as a subphrase. 'text' means that at least one of the search terms values must match the query, but unlike 'phrase', the query only needs to match part of the value.",
            "enum": ["keywords","text","phrase"],
            "default": "keywords"
          }
        }

groups

Show child attributes

        {
          "groups": {
            "type": "string",
            "title": "Rule Group",
            "description": "Group for this rule."
          }
        }

effective_range

Show child attributes

        {
          "effective_range": {
            "type": "array",
            "title": "Effective Range",
            "description": "Time range when this rule is in effect.",
            "items": { "type": "string" }
          }
        }

priority

Show child attributes

        {
          "priority": {
            "type": "integer",
            "title": "Precedence",
            "description": "Used when multiple rules could take effect for a given query - higher number means higher precedence. For example, a rule with precedence of 10 will take effect before a rule with precedence of 3. Ties on precedence are broken based on creation time - the more recently created rule will take effect before the older rule."
          }
        }

search_terms

Show child attributes

        {
          "search_terms": {
            "type": "array",
            "title": "Search Terms",
            "description": "Search terms that trigger this rule.",
            "items": { "type": "string" }
          }
        }

filters

Show child attributes

        {
          "filters": {
            "type": "array",
            "title": "Filters",
            "description": "Filters used to determine if this rule triggers",
            "items": {
              "type": "object",
              "required": ["key","value"],
              "properties": {
                "key": { "type": "string", "title": "Field Name" },
                "value": { "type": "string", "title": "Field Value" }
              }
            }
          }
        }

response_values

Show child attributes

        {
          "response_values": {
            "type": "array",
            "title": "Set Response Values",
            "description": "Key/Value pairs to set in the fusion section of the response.",
            "hints": ["hidden"],
            "items": {
              "type": "object",
              "required": ["key","value"],
              "properties": {
                "key": { "type": "string", "title": "Field Name" },
                "value": { "type": "string", "title": "Field Value" }
              }
            }
          }
        }

query_profile_id_ss

Show child attributes

        {
          "query_profile_id_ss": {
            "type": "array",
            "title": "Query Profile ID",
            "description": "Query Profile that triggers this rule",
            "items": { "type": "string" }
          }
        }

type Required

Show child attributes

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

doc_type

Show child attributes

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

display_type

Show child attributes

        {
          "display_type": {
            "type": "string",
            "title": "Display Type",
            "enum": ["Response Value"],
            "default": "Response Value",
            "hints": ["readonly"]
          }
        }

additionalProperties

Show child attributes

        {
          "additionalProperties": true
        }

UI tour

Index data

Query data

Metrics and analytics

Improve your queries

Administration

Developer documentation

Machine learning

Neural Hybrid Search

Release notes

FAQs

Response Value

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

​Response Value

​General information

Response Value

General information