(C) 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 C/C++ Library Downloads
MS Visual C/C++ C++ Builder Linux C/C++ Alpine Linux C/C++	MacOS C/C++ iOS C/C++ Android C/C++ MinGW C/C++

#include <C_CkAi.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkAi ai;
    HCkJsonObject azureParams;
    HCkStringBuilder sbResponse;

    success = FALSE;

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

    ai = CkAi_Create();

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

    // Use your provider's API key.
    CkAi_putApiKey(ai,"MY_API_KEY");

    // Set Azure Foundry specific params.
    azureParams = CkJsonObject_Create();

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

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

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

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

    // Such as eastus
    CkJsonObject_UpdateString(azureParams,"azure.location","LOCATION");

    // With the Azure-specific provider params specified,
    // Chilkat will internally fetch the OAuth2 access token using client credentials as needed.
    CkAi_SetProviderParams(ai,azureParams);

    // Choose a model.
    CkAi_putModel(ai,"gpt-4o");

    // Add a text input.
    CkAi_InputAddText(ai,"Say Hello.");

    // Ask the AI for text output.
    success = CkAi_Ask(ai,"text");
    if (success == FALSE) {
        printf("%s\n",CkAi_lastErrorText(ai));
        CkAi_Dispose(ai);
        CkJsonObject_Dispose(azureParams);
        return;
    }

    // Get the text response.
    sbResponse = CkStringBuilder_Create();
    CkAi_GetOutputTextSb(ai,sbResponse);
    printf("%s\n",CkStringBuilder_getAsString(sbResponse));

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

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


    CkAi_Dispose(ai);
    CkJsonObject_Dispose(azureParams);
    CkStringBuilder_Dispose(sbResponse);

    }