TDApiClient.API_Request is a static helper function to invoke the in-database function API_Request.
This function returns a teradataml DataFrame.
Required Arguments:
- DataFrame: Specifies an input teradataml DataFrame which acts as the input query for the API_Request in-database function.
- See list of additional required arguments and corresponding parameters in the in-database function API_Request in the following table.
Optional Arguments: Specifies key-value arguments to be passed to the in-database function API_Request. See list of these key-value arguments in the following table.
The following table shows the mapping between TDApiClient.API_Request arguments to the corresponding parameters in the in-database function API_Request. For details of these parameters, see API_Request In-database Function Syntax Elements.
| TDApiClient.API_Request Argument | Required/Optional | API_Request in-database function Parameter |
|---|---|---|
| api_type | Required | API_TYPE |
| authorization | Required | AUTHORIZATION |
| endpoint | Optional | ENDPOINT |
| num_embeddings | Optional | NUM_EMBEDDINGS |
| model_name | Optional | MODEL_NAME |
| data_columns | Required for embeddings | DATA_COLUMNS |