PureBasic Requires Chilkat v11.3.0+

Azure AI Foundry Query

See more AI Examples

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

IncludeFile "CkAi.pb"
IncludeFile "CkStringBuilder.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

    ;  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-5.6-terra".  After substitution the base URL becomes: 
    ;  https://chilkat.cognitiveservices.azure.com/openai/deployments/gpt-5.6-terra/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")

    ;  Choose a model.
    CkAi::setCkModel(ai, "gpt-5.6-terra")

    ;  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)
        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)
    CkStringBuilder::ckDispose(sbResponse)


    ProcedureReturn
EndProcedure