Java 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. Chilkat2 Java

import com.chilkatsoft.chilkat2.Ai;
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // This example assumes the Chilkat API to have been previously unlocked.
        // See Global Unlock Sample for sample code.

        Ai ai = new Ai();

        // For Azure AI Foundry we use "custom".
        ai.setProvider("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"
        ai.setBaseUrl("https://chilkat.cognitiveservices.azure.com/openai/deployments/{deployment}/chat/completions?api-version=2025-01-01-preview");
        ai.setApiSpec("ChatCompletions");

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

        // Choose a model.
        ai.setModel("gpt-5.6-terra");

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

        // Ask the AI for text output.
        try {
            ai.ask("text");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Get the text response.
        StringBuilder sbResponse = new StringBuilder();
        ai.getOutputTextSb(sbResponse);
        System.out.println(sbResponse.getAsString());

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

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