For the complete documentation index, see llms.txt. This page is also available as Markdown.

Apply Rules

These actions provide ability to evaluate a list of rules and returns results based on matches.

Apply Rules Actions

Process / ProcessSimpleRules

Evaluates list of rules for a domain and returns the result of matching rule. Event metadata fields applicable for this action are as follows:

Field
Definition
Example
Default

Domain

Set of rules to apply

risk_scoring

-

Input Element

Json path for the input in event payload for query variables

parameters

-

Output Element

Json path for the output in response event payload where "result" or "results" element will be added

$.decision

-

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "description": "Set of rules to apply",
          "example": "risk_scoring"
        },
        "inputElement": {
          "type": "string",
          "description": "Json path for the input in event payload for query variables",
          "example": "parameters"
        },
        "outputElement": {
          "type": "string",
          "description": "Json path for the output in response event payload where \"result\" or \"results\" element will be added",
          "example": "$.decision"
        }
      }
    }
  }
}

With event metadata parameters as:

Parameter
Definition
Example
Default

Input Pattern

JMESPath pattern to apply on data input

{id:id, group:data.group}

-

Structure

Whether the "result" of highest salience rule or "results" list of all matching rules should return

list

single

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "parameters": {
          "type": "object",
          "properties": {
            "inputPattern": {
              "type": "string",
              "description": "JMESPath pattern to apply on data input",
              "example": "{id:id, group:data.group}"
            },
            "structure": {
              "type": "string",
              "description": "Whether the \"result\" of highest salience rule or \"results\" list of all matching rules should return",
              "enum": ["single", "list"],
              "default": "single",
              "example": "list"
            }
          }
        }
      }
    }
  }
}

Last updated