(Lianja) Azure AI Foundry Query

This is the simplest example of using Chilkat with Azure AI Foundry.

Note: This example requires Chilkat v11.3.0 or greater.

Chilkat Lianja Extension Download Chilkat Lianja Extension

llSuccess = .F.

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loAi = createobject("CkAi")

// Before running the code, ensure the following prerequisites for App Registration in Microsoft Entra ID for Azure AI Foundry:
// 1. Register an app for Azure AI Foundry.
// 2. Assign an IAM Role to the resource to enable OAuth2 Client-Credentials for calling Azure AI Foundry.

// For Azure AI Foundry we use "custom".
loAi.Provider = "custom"

// The base URL format for the Chat Completions API when using the cognitiveservices.azure.com domain is:
// https://{resource-name}.cognitiveservices.azure.com/openai/deployments/{deployment-id}/chat/completions?api-version={api-version}

// The string "{deployment}" in the base URL is dynamically replaced with the selected AI model each time a request is sent.
// In this case, the chosen model (below) is "gpt-4o".  After substitution the base URL becomes: 
// https://chilkat.cognitiveservices.azure.com/openai/deployments/gpt-4o/chat/completions?api-version=2025-01-01-preview

// In this example, our resource name is "chilkat", and the api-version is "2025-01-01-preview"
loAi.BaseUrl = "https://chilkat.cognitiveservices.azure.com/openai/deployments/{deployment}/chat/completions?api-version=2025-01-01-preview"
loAi.ApiSpec = "ChatCompletions"

// Use your provider's API key.
loAi.ApiKey = "MY_API_KEY"

// Set Azure Foundry specific params.
loAzureParams = createobject("CkJsonObject")

// The tenant ID is a GUID such as 17280f2d-f709-4a7b-af1d-9928190e13cf
loAzureParams.UpdateString("azure.tenantId","TENANT_ID")

// The client ID is a GUID such as 4abd4bf6-5260-4795-90f6-1e91ce4f582c
loAzureParams.UpdateString("azure.clientId","CLIENT_ID")

// Such as UZc8Q~YBrRIgfe_zbAOwWV.8ikuHa3JJF7LvCdt.  (this is not a GUID)
loAzureParams.UpdateString("azure.clientSecret","CLIENT_SECRET")

// The subscription ID is a GUID such as 4abd4bf6-5260-4795-90f6-1e91ce4f582c
loAzureParams.UpdateString("azure.subscription","SUBSCRIPTION_ID")

// Such as eastus
loAzureParams.UpdateString("azure.location","LOCATION")

// With the Azure-specific provider params specified,
// Chilkat will internally fetch the OAuth2 access token using client credentials as needed.
loAi.SetProviderParams(loAzureParams)

// Choose a model.
loAi.Model = "gpt-4o"

// Add a text input.
loAi.InputAddText("Say Hello.")

// Ask the AI for text output.
llSuccess = loAi.Ask("text")
if (llSuccess = .F.) then
    ? loAi.LastErrorText
    release loAi
    release loAzureParams
    return
endif

// Get the text response.
loSbResponse = createobject("CkStringBuilder")
loAi.GetOutputTextSb(loSbResponse)
? loSbResponse.GetAsString()

// Sample output:
// Hello! How can I assist you today?

// -------------------------------------------------------------
// The response is in markdown format.
// Also see Markdown to HTML Conversion Examples.
// -------------------------------------------------------------


release loAi
release loAzureParams
release loSbResponse