(Perl) 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 Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux

use chilkat();

$success = 0;

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

$ai = chilkat::CkAi->new();

# 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".
$ai->put_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"
$ai->put_BaseUrl("https://chilkat.cognitiveservices.azure.com/openai/deployments/{deployment}/chat/completions?api-version=2025-01-01-preview");
$ai->put_ApiSpec("ChatCompletions");

# Use your provider's API key.
$ai->put_ApiKey("MY_API_KEY");

# Set Azure Foundry specific params.
$azureParams = chilkat::CkJsonObject->new();

# The tenant ID is a GUID such as 17280f2d-f709-4a7b-af1d-9928190e13cf
$azureParams->UpdateString("azure.tenantId","TENANT_ID");

# The client ID is a GUID such as 4abd4bf6-5260-4795-90f6-1e91ce4f582c
$azureParams->UpdateString("azure.clientId","CLIENT_ID");

# Such as UZc8Q~YBrRIgfe_zbAOwWV.8ikuHa3JJF7LvCdt.  (this is not a GUID)
$azureParams->UpdateString("azure.clientSecret","CLIENT_SECRET");

# The subscription ID is a GUID such as 4abd4bf6-5260-4795-90f6-1e91ce4f582c
$azureParams->UpdateString("azure.subscription","SUBSCRIPTION_ID");

# Such as eastus
$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.
$ai->SetProviderParams($azureParams);

# Choose a model.
$ai->put_Model("gpt-4o");

# Add a text input.
$ai->InputAddText("Say Hello.");

# Ask the AI for text output.
$success = $ai->Ask("text");
if ($success == 0) {
    print $ai->lastErrorText() . "\r\n";
    exit;
}

# Get the text response.
$sbResponse = chilkat::CkStringBuilder->new();
$ai->GetOutputTextSb($sbResponse);
print $sbResponse->getAsString() . "\r\n";

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

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