teradataml 20.0.0.8__py3-none-any.whl

teradataml/data/jsons/sqle/17.05/nPath.json

@@ -0,0 +1,269 @@
+{
+  "json_schema_major_version": "1",
+  "json_schema_minor_version": "2",
+  "json_content_version": "1",
+  "function_name": "nPath",
+  "function_version": "1.1",
+  "function_type": "fastpath",
+  "function_category": "Path and Pattern Analysis",
+  "function_alias_name": "nPath",
+  "function_r_name": "aa.npath",
+  "short_description": "The nPath function matches specified patterns in a sequence of rows from one or more input tables and extracts information from the matched rows.",
+  "long_description": "The nPath function matches specified patterns in a sequence of rows from one or more input tables and extracts information from the matched rows.",
+  "input_tables": [
+    {
+      "requiredInputKind": [
+        "PartitionByKey"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "input1",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Input table",
+      "description": "Input table",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data1",
+      "useInR": true,
+      "rOrderNum": 1
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey",
+        "Dimension"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "input2",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Additional optional input table",
+      "description": "Additional optional input table",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data2",
+      "useInR": true,
+      "rOrderNum": 7
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey",
+        "Dimension"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "input3",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Additional optional input table",
+      "description": "Additional optional input table",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data3",
+      "useInR": true,
+      "rOrderNum": 8
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey",
+        "Dimension"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "input4",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Additional optional input table",
+      "description": "Additional optional input table",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data4",
+      "useInR": true,
+      "rOrderNum": 9
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey",
+        "Dimension"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "input5",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Additional optional input table",
+      "description": "Additional optional input table",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data5",
+      "useInR": true,
+      "rOrderNum": 10
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey",
+        "Dimension"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "input6",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Additional optional input table",
+      "description": "Additional optional input table",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data6",
+      "useInR": true,
+      "rOrderNum": 11
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey",
+        "Dimension"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "input7",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Additional optional input table",
+      "description": "Additional optional input table",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data7",
+      "useInR": true,
+      "rOrderNum": 12
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey",
+        "Dimension"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "input8",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Additional optional input table",
+      "description": "Additional optional input table",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data8",
+      "useInR": true,
+      "rOrderNum": 13
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey",
+        "Dimension"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "input9",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Additional optional input table",
+      "description": "Additional optional input table",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data9",
+      "useInR": true,
+      "rOrderNum": 14
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey",
+        "Dimension"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "input10",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Additional optional input table",
+      "description": "Additional optional input table",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data10",
+      "useInR": true,
+      "rOrderNum": 15
+    }
+  ],
+  "argument_clauses": [
+    {
+      "permittedValues": [
+        "OVERLAPPING",
+        "NONOVERLAPPING"
+       ],
+      "isOutputColumn": false,
+      "name": "Mode",
+      "alternateNames": [],
+      "rDescription": "Specifies the pattern-matching mode: \n OVERLAPPING: The function finds every occurrence of the pattern in the partition, regardless of  whether it is part of a previously found match. Therefore, one row can match multiple symbols in a  given matched pattern. \n NONOVERLAPPING: The function begins the next pattern search at the row that follows the last  pattern match. This is the default behavior of many commonly used pattern matching utilities, including the UNIX grep utility.",
+      "description": "Specifies the pattern-matching mode: \n OVERLAPPING: The function finds every occurrence of the pattern in the partition, regardless of  whether it is part of a previously found match. Therefore, one row can match multiple symbols in a  given matched pattern. \n NONOVERLAPPING: The function begins the next pattern search at the row that follows the last  pattern match. This is the default behavior of many commonly used pattern matching utilities, including the UNIX grep utility.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "isRequired": true,
+      "rName": "mode",
+      "useInR": true,
+      "rOrderNum": 2
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "Pattern",
+      "alternateNames": [],
+      "rDescription": "Specifies the pattern for which the function searches. You compose pattern with the symbols that you define in the symbols argument, operators, and parentheses. Table describes the simplest patterns, which you can combine to form more complex patterns. When patterns have multiple operators, the function applies them in order of precedence, and applies operators of equal precedence from left to right. Table also shows operator precedence. To force the function to evaluate a subpattern first, enclose it in parentheses. To specify that a subpattern must appear a specific number of times, use the 'Range-Matching Feature'.\n For pattern matching details, refer to 'Pattern Matching'.",
+      "description": "Specifies the pattern for which the function searches. You compose pattern with the symbols that you define in the Symbols argument, operators, and parentheses. Table describes the simplest patterns, which you can combine to form more complex patterns. When patterns have multiple operators, the function applies them in order of precedence, and applies operators of equal precedence from left to right. Table also shows operator precedence. To force the function to evaluate a subpattern first, enclose it in parentheses. To specify that a subpattern must appear a specific number of times, use the 'Range-Matching Feature' \n For pattern matching details, refer to 'Pattern Matching'.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "isRequired": true,
+      "rName": "pattern",
+      "useInR": true,
+      "rOrderNum": 3
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "Symbols",
+      "alternateNames": [],
+      "rDescription": "Defines the symbols that appear in the values of the pattern and result arguments. The col_expr is an expression whose value is a column name, symbol is any valid identifier, and  symbol_predicate is a SQL predicate (often a column name).\n For example, the Symbols argument for analyzing website visits might look like this: \nsymbols \n(\n pagetype = 'homepage' AS H, \npagetype <> 'homepage' AND  pagetype <> 'checkout' AS PP,\n pagetype = 'checkout' AS CO \n)\n The symbol is case-insensitive; however, a symbol of one or two uppercase letters is easy to identify in patterns. \nIf col_expr represents a column that appears in multiple input tables, then you must qualify the ambiguous column name with its table name. For example: \n Symbols \n ( \n weblog.pagetype = 'homepage' AS H, \n weblog.pagetype = 'thankyou' AS T, \n ads.adname = 'xmaspromo' AS X, \n ads.adname = 'realtorpromo' AS R \n) \nFor more information about symbols that appear in the Pattern argument value, refer to 'symbols'. For more information about symbols that appear in the Result argument value, refer to 'result: Applying Aggregate Functions'.",
+      "description": "Defines the symbols that appear in the values of the Pattern and Result arguments. The col_expr is an expression whose value is a column name, symbol is any valid identifier, and  symbol_predicate is a SQL predicate (often a column name).\n For example, the Symbols argument for analyzing website visits might look like this: \n Symbols \n (\n pagetype = 'homepage' AS H, \n pagetype <> 'homepage' AND  pagetype <> 'checkout' AS PP, \n pagetype = 'checkout' AS CO \n)\n The symbol is case-insensitive; however, a symbol of one or two uppercase letters is easy to identify in patterns. If col_expr represents a column that appears in multiple input tables, then you must qualify the ambiguous column name with its table name. For example: Symbols ( weblog.pagetype = 'homepage' AS H, weblog.pagetype = 'thankyou' AS T, ads.adname = 'xmaspromo' AS X, ads.adname = 'realtorpromo' AS R ) For more information about symbols that appear in the Pattern argument value, refer to 'Symbols'. For more information about symbols that appear in the Result argument value, refer to 'Result: Applying Aggregate Functions'.",
+      "datatype": "STRING",
+      "isRequired": true,
+      "allowsLists": true,
+      "rName": "symbols",
+      "useInR": true,
+      "rOrderNum": 4
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+	   "name": "Filter",
+	   "alternateNames": [],
+	   "isRequired": false,
+	   "rDescription": "Specifies filters to impose on the matched rows. The function combines the filter expressions using the AND operator. \nThe filter_expression syntax is: \nsymbol_expression  comparison_operator symbol_expression \nThe two symbol expressions must be type-compatible. The symbol_expression syntax is: \n{ FIRST | LAST }(column_with_expression OF [ANY](symbol[,...])) \nThe column_with_expression cannot contain the operator AND or OR, and all its columns must come from the same input. If the function has multiple inputs, then column_with_expression and symbol must come from the same input. \nThe comparison_operator is either <, >, <=, >=, =, or <>.",
+      "description": "Specifies filters to impose on the matched rows. The function combines the filter expressions using the AND operator. \nThe filter_expression syntax is: \nsymbol_expression  comparison_operator symbol_expression \nThe two symbol expressions must be type-compatible. The symbol_expression syntax is: \n{ FIRST | LAST }(column_with_expression OF [ANY](symbol[,...])) \nThe column_with_expression cannot contain the operator AND or OR, and all its columns must come from the same input. If the function has multiple inputs, then column_with_expression and symbol must come from the same input. \nThe comparison_operator is either <, >, <=, >=, =, or <>. \nThis argument can improve or degrade nPath performance, depending on several factors. For details, refer to 'Filters'",
+      "datatype": "STRING",
+      "allowsLists": true,
+      "rName": "filter",
+      "useInR": true,
+      "rOrderNum": 6
+    },
+    {
+	   "permittedValues": [],
+      "isOutputColumn": true,
+      "name": "Result",
+      "alternateNames": [],
+      "rDescription": "Defines the output columns. The col_expr is an expression whose value is a column name; it specifies the values to retrieve from the matched rows. The function applies aggregate_function  to these values. For details, see 'result: Applying Aggregate Functions'. \nThe function evaluates this argument once for every matched pattern in the partition (that is, it outputs one row for each pattern match).",
+      "description": "Defines the output columns. The col_expr is an expression whose value is a column name; it specifies the values to retrieve from the matched rows. The function applies aggregate_function  to these values. For details, see 'Result: Applying Aggregate Functions'. \nThe function evaluates this argument once for every matched pattern in the partition (that is, it outputs one row for each pattern match).",
+      "datatype": "STRING",
+      "isRequired": true,
+      "allowsLists": true,
+      "rName": "result",
+      "useInR": true,
+      "rOrderNum": 5
+    }
+  ]
+}

teradataml/data/jsons/sqle/17.10/Antiselect.json

@@ -0,0 +1,56 @@
+{
+  "json_schema_major_version": "1",
+  "json_schema_minor_version": "1",
+  "json_content_version": "1",
+  "function_name": "Antiselect",
+  "function_version": "1.0",
+  "function_alias_name": "Antiselect",
+  "function_type": "fastpath",
+  "function_category": "Feature Engineering Transform",
+  "function_r_name": "aa.antiselect",
+  "short_description": "Outputs columns except for excluded ones.",
+  "long_description": "Outputs columns from input table or inputselect query and removes columns in exclude list.",
+  "input_tables": [
+    {
+      "requiredInputKind": [
+        "PartitionByAny"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "input",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Input table",
+      "description": "Input table",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data",
+      "useInR": true,
+      "rOrderNum": 1
+    }
+  ],
+  "argument_clauses": [
+    {
+      "targetTable": [
+        "input"
+      ],
+      "checkDuplicate": false,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "ALL"
+      ],
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "Exclude",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Specifies the names of the columns not to return.",
+      "description": "Specifies the names of the columns not to return.",
+      "datatype": "COLUMNS",
+      "allowsLists": true,
+      "rName": "exclude",
+      "useInR": true,
+      "rOrderNum": 2
+    }
+  ]
+}

teradataml/data/jsons/sqle/17.10/Attribution.json

@@ -0,0 +1,249 @@
+{
+  "json_schema_major_version": "1",
+  "json_schema_minor_version": "2",
+  "json_content_version": "1",
+  "function_name": "Attribution",
+  "function_version": "1.0",
+  "function_type": "fastpath",
+  "function_category": "Path and Pattern Analysis",
+  "function_alias_name": "Attribution",
+  "function_r_name": "aa.attribution",
+  "short_description": "This function is used to perform click stream analysis.",
+  "long_description": "This function is used to perform click stream analysis.It has many kinds of computation models and distribution models.",
+  "input_tables": [
+    {
+      "requiredInputKind": [
+        "PartitionByKey"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "InputTable1",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Contains the click stream data, which the function uses to compute attributions.",
+      "description": "Contains the click stream data, which the function uses to compute attributions.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data",
+      "useInR": true,
+      "rOrderNum": 1
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "InputTable2",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Contains the click stream data, which the function uses to compute attributions.",
+      "description": "Contains the click stream data, which the function uses to compute attributions.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data.optional",
+      "useInR": true,
+      "rOrderNum": 2
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "InputTable3",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Contains the click stream data, which the function uses to compute attributions.",
+      "description": "Contains the click stream data, which the function uses to compute attributions.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data.optional2",
+      "useInR": true,
+      "rOrderNum": 3
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "InputTable4",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Contains the click stream data, which the function uses to compute attributions.",
+      "description": "Contains the click stream data, which the function uses to compute attributions.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data.optional3",
+      "useInR": true,
+      "rOrderNum": 4
+    },
+    {
+      "requiredInputKind": [
+        "PartitionByKey"
+      ],
+      "isOrdered": true,
+      "partitionByOne": false,
+      "name": "InputTable5",
+      "alternateNames": [],
+      "isRequired": false,
+      "rDescription": "Contains the click stream data, which the function uses to compute attributions.",
+      "description": "Contains the click stream data, which the function uses to compute attributions.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data.optional4",
+      "useInR": true,
+      "rOrderNum": 5
+    },
+    {
+      "requiredInputKind": [
+        "Dimension"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "ConversionEventTable",
+      "alternateNames": ["conversion"],
+      "isRequired": true,
+      "rDescription": "Contains one varchar column (conversion_events) containing conversion event values.",
+      "description": "Contains one varchar column (conversion_events) containing conversion event values.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "conversion.data",
+      "useInR": true,
+      "rOrderNum": 6
+    },
+    {
+      "requiredInputKind": [
+        "Dimension"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "ExcludedEventTable",
+      "alternateNames": ["excluding"],
+      "isRequired": false,
+      "rDescription": "Contains one varchar column (excluding_events) containing excluding cause event values.",
+      "description": "Contains one varchar column (excluding_events) containing excluding cause event values.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "excluding.data",
+      "useInR": true,
+      "rOrderNum": 7
+    },
+    {
+      "requiredInputKind": [
+        "Dimension"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "OptionalEventTable",
+      "alternateNames": ["optional"],
+      "isRequired": false,
+      "rDescription": "Contains one varchar column (optional_events) containing optional cause event values.",
+      "description": "Contains one varchar column (optional_events) containing optional cause event values.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "optional.data",
+      "useInR": true,
+      "rOrderNum": 8
+    },
+    {
+      "requiredInputKind": [
+        "Dimension"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "FirstModel",
+      "alternateNames": ["FirstModel","model1"],
+      "isRequired": true,
+      "rDescription": "Defines the type and specification of the first model. For example: model1.data ('EVENT_REGULAR', 'email:0.19:LAST_CLICK:NA', 'impression:0.81:WEIGHTED:0.4,0.3,0.2,0.1')",
+      "description": "Defines the type and specification of the first model. For example: Model1 ('EVENT_REGULAR', 'email:0.19:LAST_CLICK:NA', 'impression:0.81:WEIGHTED:0.4,0.3,0.2,0.1')",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "model1.type",
+      "useInR": true,
+      "rOrderNum": 9
+    },
+    {
+      "requiredInputKind": [
+        "Dimension"
+      ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "SecondModel",
+      "alternateNames": ["SecondModel","model2"],
+      "isRequired": false,
+      "rDescription": "Defines the type and distributions of the second model. For example: model2.data ('EVENT_OPTIONAL', 'OrganicSearch:0.5:UNIFORM:NA', 'Direct:0.3:UNIFORM:NA', 'Referral:0.2:UNIFORM:NA')",
+      "description": "Defines the type and distributions of the second model. For example: Model2 ('EVENT_OPTIONAL', 'OrganicSearch:0.5:UNIFORM:NA', 'Direct:0.3:UNIFORM:NA', 'Referral:0.2:UNIFORM:NA')",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "model2.type",
+      "useInR": true,
+      "rOrderNum": 10
+    }
+  ],
+  "argument_clauses": [
+    {
+      "targetTable": [
+        "InputTable1"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "STRING",
+        "INTEGER"
+      ],
+      "requiredLength": 1,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "EventColumn",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Specifies the name of the input column that contains the clickstream events.",
+      "description": "Specifies the name of the input column that contains the clickstream events.",
+      "datatype": "COLUMNS",
+      "allowsLists": false,
+      "rName": "event.column",
+      "useInR": true,
+      "rOrderNum": 11
+    },
+    {
+      "targetTable": [
+        "InputTable1"
+      ],
+      "checkDuplicate": true,
+      "allowedTypes": [],
+      "allowedTypeGroups": [
+        "INTEGER",
+        "TIME"
+      ],
+      "requiredLength": 1,
+      "matchLengthOfArgument": "",
+      "allowPadding": false,
+      "name": "TimeColumn",
+      "alternateNames": ["TimestampColumn"],
+      "isRequired": true,
+      "rDescription": "Specifies the name of the input column that contains the timestamps of the clickstream events.",
+      "description": "Specifies the name of the input column that contains the timestamps of the clickstream events.",
+      "datatype": "COLUMNS",
+      "allowsLists": false,
+      "rName": "timestamp.column",
+      "useInR": true,
+      "rOrderNum": 12
+    },
+    {
+      "permittedValues": [],
+      "isOutputColumn": false,
+      "name": "WindowSize",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Specifies how to determine the maximum window size for the attribution calculation: rows:K: Consider the maximum number of events to be attributed, excluding events of types specified in excluding_event_table, which means assigning attributions to at most K effective events before the current impact event.seconds:K: Consider the maximum time difference between the current impact event and the earliest effective event to be attributed. rows:K&seconds:K2: Consider both constraints and comply with the stricter one.",
+      "description": "Specifies how to determine the maximum window size for the attribution calculation: rows:K: Consider the maximum number of events to be attributed, excluding events of types specified in excluding_event_table, which means assigning attributions to at most K effective events before the current impact event.seconds:K: Consider the maximum time difference between the current impact event and the earliest effective event to be attributed. rows:K&seconds:K2: Consider both constraints and comply with the stricter one.",
+      "datatype": "STRING",
+      "allowsLists": false,
+      "rName": "window.size",
+      "useInR": true,
+      "rOrderNum": 13
+    }
+  ]
+}