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

Pinned

The Pinned action sticks a document to a specific location within the search results. This ensures that users view a result in a specified place. For example, a workplace may pin documents answering frequently asked questions.

General information

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

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

name Required

Hide child attributes

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

description

Hide child attributes

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

enabled

Hide child attributes

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

matching

Hide child attributes

        {
          "matching": {
            "type": "string",
            "title": "Match Query Using",
            "description": "Defines how the specified search terms will be compared to the user's query.",
            "enum": ["keywords", "text", "phrase"],
            "default": "keywords"
          }
        }

groups

Hide child attributes

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

effective_range

Hide child attributes

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

priority

Hide child attributes

        {
          "priority": {
            "type": "integer",
            "title": "Precedence",
            "description": "Higher number means higher precedence. Ties broken by creation time."
          }
        }

search_terms

Hide child attributes

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

filters

Hide 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

Hide child attributes

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

query_profile_id_ss

Hide child attributes

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

field_name Required

Hide child attributes

        {
          "field_name": {
            "type": "string",
            "title": "Field Name",
            "description": "Set the field name used by this rule to match the specified values.",
            "default": "id"
          }
        }

field_values

Hide child attributes

        {
          "field_values": {
            "type": "array",
            "title": "Field Values",
            "description": "List of values for the specified field.",
            "hints": ["hidden"],
            "minItems": 1,
            "items": { "type": "string" }
          }
        }

use_qec

Hide child attributes

        {
          "use_qec": {
            "type": "boolean",
            "title": "Use Query Elevation Component",
            "description": "Set true to use Solr's QEC to force-elevate documents to the top. QEC only supports elevation through \"id\" field. Failed to config QEC in Solr correctly while having this box checked will cause this rule to stop working.",
            "default": false
          }
        }

pinned_values Required

Hide child attributes

        {
          "pinned_values": {
            "type": "array",
            "title": "Pinned Documents",
            "description": "A list of one or more documents to boost and pin to specific positions in the results (1-based index). Note that pinning will only be applied to the first page of results.",
            "minItems": 1,
            "items": {
              "type": "object",
              "required": ["value", "position"],
              "properties": {
                "value": {
                  "type": "string",
                  "title": "Value",
                  "description": "Value to boost"
                },
                "position": {
                  "type": "integer",
                  "title": "Position",
                  "description": "Absolute position in the first page of results (1-based index)"
                }
              }
            }
          }
        }

type Required

Hide child attributes

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

doc_type

Hide child attributes

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

display_type

Hide child attributes

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

additionalProperties

Hide 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

Pinned

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

​Pinned

​General information

Pinned

General information