Product Selector

Fusion 5.9
    Fusion 5.9

    Similar Queries (simq) Query Rewrite API ConfigurationsManaged Fusion Query Rewrite APIs

    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.

    simq

    The similar queries table

    If query leads to clicks on documents 1, 2, 3, and 4, and similar_query leads to clicks on documents 2, 3, 4, and 5, then there is sufficient overlap between the two queries to consider them similar.

    A statistic is constructed to compute similarities based on overlap counts and query counts. The resulting table consists of documents whose doc_type value is "query_rewrite" and type value is "simq".

    For more information, see The similar queries table.

    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

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

    query

    		 
        "query": {
      "type": "string",
      "title": "Query",
      "description": "A query that has a similar query."
    }

    similar_query

    		 
        "similar_query": {
      "type": "string",
      "title": "Similar Query",
      "description": "Similar query"
    }

    query_count

    		 
        "query_count": {
      "type": "integer",
      "title": "Query Count",
      "description": "Query count"
    }

    similar_query_count

    		 
        "similar_query_count": {
      "type": "integer",
      "title": "Similar Query Count",
      "description": "Similar Query count"
    }

    similarity

    		 
        "similarity": {
      "type": "number",
      "title": "Similarity",
      "description": "Measure of how similar the two queries are."
    }

    type

    Required

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

    doc_type

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

    additionalProperties

    additionalProperties

    		 
    "additionalProperties": true