(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
integer li_Success
oleobject loo_Ai
oleobject loo_AzureParams
oleobject loo_SbResponse

li_Success = 0

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

loo_Ai = create oleobject
li_rc = loo_Ai.ConnectToNewObject("Chilkat.Ai")
if li_rc < 0 then
    destroy loo_Ai
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// 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".
loo_Ai.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"
loo_Ai.BaseUrl = "https://chilkat.cognitiveservices.azure.com/openai/deployments/{deployment}/chat/completions?api-version=2025-01-01-preview"
loo_Ai.ApiSpec = "ChatCompletions"

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

// Set Azure Foundry specific params.
loo_AzureParams = create oleobject
li_rc = loo_AzureParams.ConnectToNewObject("Chilkat.JsonObject")

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

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

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

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

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

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

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

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

// Ask the AI for text output.
li_Success = loo_Ai.Ask("text")
if li_Success = 0 then
    Write-Debug loo_Ai.LastErrorText
    destroy loo_Ai
    destroy loo_AzureParams
    return
end if

// Get the text response.
loo_SbResponse = create oleobject
li_rc = loo_SbResponse.ConnectToNewObject("Chilkat.StringBuilder")

loo_Ai.GetOutputTextSb(loo_SbResponse)
Write-Debug loo_SbResponse.GetAsString()

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

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


destroy loo_Ai
destroy loo_AzureParams
destroy loo_SbResponse