API_Request In-database Function Syntax | OpenAI and Azure OpenAI | Teradata - API_Request In-database Function Syntax - Teradata VantageCloud Lake

Lake - Analyze Your Data with ClearScape Analytics™
Deployment
VantageCloud
Edition
Lake
Product
Teradata VantageCloud Lake
Release Number
Published
February 2025
ft:locale
en-US
ft:lastEdition
2026-02-20
dita:mapPath
tcl1683670667798.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
tcl1683670667798

For connecting to OpenAI

SELECT * FROM tapidb.API_Request(
    ON { table | view | (query) } AS InputTable
    USING
    AUTHORIZATION('{"key": "open-ai-key",
    [NUM_EMBEDDINGS('integer-number-of-embeddings-columns')]
    [MODEL_NAME('openai-model-name')]
    [API_TYPE('open-ai-embedding')]
    TEXT_COLUMN('name-of-text-column-input-to-embedding')
) AS alias;

For connecting to Azure OpenAI using Azure resource name and deployment

SELECT * FROM tapidb.API_Request(
    ON { table | view | (query) } AS InputTable
    USING
    AUTHORIZATION('{"Key":"az_ai_key", "Resource" : "azure_resource_name", "Deployment" : "azure_deployment_name"}') 
    [NUM_EMBEDDINGS('integer-number-of-embeddings-columns')]
    [MODEL_NAME('az-ai-model-name')]
    [API_TYPE('az-ai-embedding')]
    TEXT_COLUMN('name-of-text-column-input-to-embedding')
) AS alias;

For connecting to Azure OpenAI using Azure endpoint

SELECT * FROM tapidb.API_Request(
    ON { table | view | (query) } AS InputTable
    USING
    AUTHORIZATION('{"Key":"az_ai_key"}') 
    [NUM_EMBEDDINGS('integer-number-of-embeddings-columns')]
    [MODEL_NAME('az-ai-model-name')]
    [API_TYPE('az-ai-embedding')]
    ENDPOINT('azure-ai-endpoint-url')
    TEXT_COLUMN('name-of-text-column-input-to-embedding')
) AS alias;