TDApiClient.API_Request | Google Vertex AI teradataml Extension Library - TDApiClient.API_Request - Teradata Vantage

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:

• options: 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.

This 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.

Example

from TDApiClient import TDApiClient

auth_info_fmt_str = ('{{ "key": "{}", "region" : "{}", "project": "{}"}}')

auth_info = auth_info_fmt_str.format(
            gcp_credentials_token,
            gcp_region,
            gcp_project_id
            )

df = TDApiClient.API_Request(reviews_df, "vertex-ai",
                          authorization=auth_info,
                          endpoint='6918043599082881024',
                          key_start_index=1)