teradataml 20.0.0.4__py3-none-any.whl → 20.0.0.5__py3-none-any.whl

teradataml/data/jsons/sqle/20.00/AI_AskLLM.json

@@ -0,0 +1,420 @@
+{
+  "json_schema_major_version": "1",
+  "json_schema_minor_version": "2",
+  "json_content_version": "1",
+  "function_name": "AI_AskLLM",
+  "function_version": "1.0",
+  "function_type": "fastpath",
+  "function_category": "Text Analytics AI",
+  "function_alias_name": "AIAskLLM",
+  "function_r_name": "aa.ai_askllm",
+  "supports_view": false,
+  "short_description": "This function enables users to provide a tailored prompt to the LLM, enhancing results according to their unique use cases or data input requirements. Users will have the option to specify two input columns: one for the data and the other for a question or reference.",
+  "long_description": "This function enables users to provide a tailored prompt to the LLM, enhancing results according to their unique use cases or data input requirements. Users will have the option to specify two input columns: one for the data and the other for a question or reference.",
+  "input_tables": [
+    {
+      "requiredInputKind": [
+          "PartitionByAny",
+          "PartitionByKey"
+        ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "InputTable",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Specifies the table containing the questions.",
+      "description": "Specifies the table containing the questions.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "data",
+      "useInR": true,
+      "rOrderNum": 0
+    },
+    {
+      "requiredInputKind": [
+          "PartitionByAny",
+          "PartitionByKey"
+        ],
+      "isOrdered": false,
+      "partitionByOne": false,
+      "name": "ContextTable",
+      "alternateNames": [],
+      "isRequired": true,
+      "rDescription": "Specifies the table containing the context to answer the question.",
+      "description": "Specifies the table containing the context to answer the question.",
+      "datatype": "TABLE_ALIAS",
+      "allowsLists": false,
+      "rName": "context",
+      "useInR": true,
+      "rOrderNum": 1
+    }
+
+  ],
+  "argument_clauses": [
+      {
+        "name": "ApiBase",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 2,
+        "allowNaN": false,
+        "description": "Specifies the LLM API base URL for azure.",
+        "rDescription": "Specifies the LLM API base URL for azure.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "api.base",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "ApiKey",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 3,
+        "allowNaN": false,
+        "description": "Specifies the LLM API Key for azure.",
+        "rDescription": "Specifies the LLM API Key for azure.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "api.key",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "ApiVersion",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 4,
+        "allowNaN": false,
+        "description": "Specifies the LLM API version for azure.",
+        "rDescription": "Specifies the LLM API version for azure.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "api.version",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "DeploymentId",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 5,
+        "allowNaN": false,
+        "description": "Specifies the deployment id of the LLM. It takes engine id for azure OpenAI.",
+        "rDescription": "Specifies the deployment id of the LLM. It takes engine id for azure OpenAI.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "deployment.id",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "ModelName",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 6,
+        "allowNaN": false,
+        "description": "Name of the large language model to be used for text analytics tasks.",
+        "rDescription": "Name of the large language model to be used for text analytics tasks.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "model.name",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "ModelArgs",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 7,
+        "allowNaN": false,
+        "description": "JSON string representing the inference parameters for the selected LLM Model.",
+        "rDescription": "JSON string representing the inference parameters for the selected LLM Model.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "model.args",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "ApiType",
+        "alternateNames": [],
+        "isRequired": true,
+        "rOrderNum": 8,
+        "permittedValues": ["azure","aws","gcp","nim"],
+        "allowNaN": false,
+        "description": "Identification of the cloud platform.",
+        "rDescription": "Identification of the cloud platform.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "api.type",
+        "useInR": true,
+        "rFormulaUsage": false,
+        "rDefaultValue": null
+      },
+      {
+        "name": "AccessKey",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 9,
+        "allowNaN": false,
+        "description": "Specifies the AWS Bedrock service access key.",
+        "rDescription": "Specifies the AWS Bedrock service access key.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "access.key",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "SecretKey",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 10,
+        "allowNaN": false,
+        "description": "Specifies the AWS Bedrock service secret key.",
+        "rDescription": "Specifies the AWS Bedrock service secret key.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "secret.key",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "SessionKey",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 11,
+        "allowNaN": false,
+        "description": "Specifies the AWS bedrock service session key.",
+        "rDescription": "Specifies the AWS bedrock service session key.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "session.key",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "Region",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 12,
+        "allowNaN": false,
+        "description": "Specifies the name of the AWS Bedrock service region or Google Cloud service region depending on the api type.",
+        "rDescription": "Specifies the name of the AWS Bedrock service region or Google Cloud service region depending on the api type.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "region",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      
+      {
+        "name": "AccessToken",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 13,
+        "allowNaN": false,
+        "description": "Specifies the session token for google cloud.",
+        "rDescription": "Specifies the session token for google cloud.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "access.token",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "Project",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum": 14,
+        "allowNaN": false,
+        "description": "Specify the name of the gcp project.",
+        "rDescription": "Specify the name of the gcp project.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "project",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "EnableSafety",
+        "alternateNames": [],
+        "isRequired": false,
+        "defaultValue": "TRUE",
+        "rOrderNum": 15,
+        "permittedValues": ["TRUE", "FALSE"],
+        "allowNaN": false,
+        "description": "Specifies if the safety feature needs to be enabled when api_type is gcp.",
+        "rDescription": "Specifies if the safety feature needs to be enabled when api_type is gcp.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "enable.safety",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "targetTable": [
+          "InputTable"
+        ],
+        "checkDuplicate": true,
+        "allowedTypes": ["VARCHAR"],
+        "allowedTypeGroups": [
+          "VARCHAR"
+        ],
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "name": "TextColumn",
+        "alternateNames": [],
+        "isRequired": true,
+        "rDescription": "Specifies the name of the text column to be used as input.",
+        "description": "Specifies the name of the text column to be used as input.",
+        "datatype": "COLUMNS",
+        "allowsLists": false,
+        "rName": "text.column",
+        "useInR": true,
+        "rFormulaUsage": false,
+        "rOrderNum": 16
+      },
+  
+      {
+        "defaultValue": true,
+        "permittedValues": [
+          "true",
+          "false"
+        ],
+        "isOutputColumn": false,
+        "name": "isDebug",
+        "alternateNames": [],
+        "isRequired": false,
+        "rDescription": "Specify whether error logging is required.",
+        "description": "Specify whether error logging is required.",
+        "datatype": "BOOLEAN",
+        "allowsLists": false,
+        "rName": "isDebug",
+        "useInR": true,
+        "rOrderNum": 17
+      },
+      {
+          "targetTable": [
+            "InputTable"
+          ],
+          "checkDuplicate": true,
+          "allowedTypes": [],
+          "allowedTypeGroups": [
+            "ALL"
+          ],
+          "matchLengthOfArgument": "",
+          "allowPadding": false,
+          "name": "Accumulate",
+          "alternateNames": [],
+          "isRequired": false,
+          "rDescription": "Specifies the input table columns to copy to the output table. By default, the function doesn't copy any input table columns to the output table.",
+          "description": "Specifies the input table columns to copy to the output table. By default, the function doesn't copy any input table columns to the output table.",
+          "datatype": "COLUMNS",
+          "allowsLists": true,
+          "rName": "accumulate",
+          "useInR": true,
+          "rOrderNum": 18
+      },
+      {
+        "name": "AUTHORIZATION",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum":19,
+        "allowNaN": false,
+        "description": "Specifies the authorization object name containing the credentials, optionally prefixed by the database name.",
+        "rDescription": "Specifies the authorization object name containing the credentials, optionally prefixed by the database name.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "authorization",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "prompt",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum":20,
+        "allowNaN": false,
+        "description": "Specifies the custom prompt.",
+        "rDescription": "SSpecifies the custom prompt.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "prompt",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "QUESTIONPOSITION",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum":21,
+        "allowNaN": false,
+        "description": "Specifies the position of the question in the custom prompt.",
+        "rDescription": "Specifies the position of the question in the custom prompt.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "question.position",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "name": "DATAPOSITION",
+        "alternateNames": [],
+        "isRequired": false,
+        "rOrderNum":22,
+        "allowNaN": false,
+        "description": "Specifies the position of the input data in the custom prompt.",
+        "rDescription": "Specifies the position of the input data in the custom prompt.",
+        "datatype": "STRING",
+        "allowsLists": false,
+        "allowPadding": true,
+        "rName": "data.position",
+        "useInR": true,
+        "rFormulaUsage": false
+      },
+      {
+        "targetTable": [
+          "ContextTable"
+        ],
+        "checkDuplicate": true,
+        "allowedTypes": ["VARCHAR"],
+        "allowedTypeGroups": [
+          "VARCHAR"
+        ],
+        "matchLengthOfArgument": "",
+        "allowPadding": false,
+        "name": "ContextColumn",
+        "alternateNames": [],
+        "isRequired": true,
+        "rDescription": "Specifies the name of the context column to be used as input.",
+        "description": "Specifies the name of the context column to be used as input.",
+        "datatype": "COLUMNS",
+        "allowsLists": false,
+        "rName": "context.column",
+        "useInR": true,
+        "rFormulaUsage": false,
+        "rOrderNum": 23
+      }
+      
+  ]
+}
+
+