(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkAi.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

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

    ai.i = CkAi::ckCreate()
    If ai.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    ; Use your provider's API key.
    CkAi::setCkApiKey(ai, "MY_API_KEY")

    ; Set Azure Foundry specific params.
    azureParams.i = CkJsonObject::ckCreate()
    If azureParams.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

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

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

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

    ; Such as eastus
    CkJsonObject::ckUpdateString(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::ckSetProviderParams(ai,azureParams)

    ; Choose a model.
    CkAi::setCkModel(ai, "gpt-4o")

    ; Add a text input.
    CkAi::ckInputAddText(ai,"Say Hello.")

    ; Ask the AI for text output.
    success = CkAi::ckAsk(ai,"text")
    If success = 0
        Debug CkAi::ckLastErrorText(ai)
        CkAi::ckDispose(ai)
        CkJsonObject::ckDispose(azureParams)
        ProcedureReturn
    EndIf

    ; Get the text response.
    sbResponse.i = CkStringBuilder::ckCreate()
    If sbResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAi::ckGetOutputTextSb(ai,sbResponse)
    Debug CkStringBuilder::ckGetAsString(sbResponse)

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

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


    CkAi::ckDispose(ai)
    CkJsonObject::ckDispose(azureParams)
    CkStringBuilder::ckDispose(sbResponse)


    ProcedureReturn
EndProcedure