API_Request In-database Function Syntax Elements | Azure Machine Learning - API_Request In-database Function Syntax Elements - Teradata Vantage

Teradata Vantageā„¢ - API Integration Guide for Cloud Machine Learning

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Teradata Vantage
Release Number
1.4
Published
September 2023
Language
English (United States)
Last Update
2023-09-28
dita:mapPath
mgu1643999543506.ditamap
dita:ditavalPath
ayr1485454803741.ditaval
dita:id
mgu1643999543506
Arguments Category Description Default Values Permitted Values Data Type Charset (Applicable for String) Case Sensitive
API_TYPE Optional Specifies the API to be used.
When working with Azure Machine Learning, the default and only permitted value is 'azure-ml'.
azure-ml azure-ml VARCHAR Unicode No
AUTHORIZATION Required Specifies a JSON string representing key or token to access endpoint. None

JSON String of the following format

'{"key" : "azure-ml-endpoint-key", "region" : "azure region string"}'

VARCHAR Unicode No, JSON keys are not case sensitive
CONTENT_FORMAT Optional Shows how the rows should be formatted.
This element is used only when CONTENT_TYPE is json.

For example: "{ "data" : [ [ "%row" ] ] }"

This will make API_Request to format row as follows: (assuming 10 columns):
{"data": [
 [1,2,3,4,5,6,7,8,9,10],
 [10,9,8,7,6,5,4,3,2,1]
]}
Empty string Value should be json string with %row placeholder where Teradata row will be placed. "%row" must be an array and it's parent may be array if model supports multiple rows. VARCHAR Unicode Yes, Value will be used as is for creating row.
CONTENT_TYPE Optional Specifies content type for sending input data to Azure Machine Learning. json
  • json
  • csv
VARCHAR Unicode Yes
ENDPOINT Required Specifies the name of Azure Machine Learning endpoint, or the scoring URL. None
  • Alphanumeric string for endpoint name
  • URL ending with ml.azure.com
VARCHAR Unicode Yes, Value is used as is for connecting to Azure.
KEY_START_INDEX Optional

Specifies the column index for the key in the input column. Column index count starts from '0'.

For example:

For SELECT col1,col2, key1, key2 from table, you should use '2' so that In-database Function will consider key1, key2 to form key to be sent to Azure.

NA NA VARCHAR Unicode No