(CkPython) Azure AI Foundry Query

See more AI Examples

Note: This example requires Chilkat v11.3.0 or greater.

Chilkat Python Downloads install with pip pip3 install chilkat or download... Python Module for Windows, MacOS, Linux, Alpine Linux

import sys
import chilkat

success = False

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

ai = chilkat.CkAi()

# 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")

# 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 == False):
    print(ai.lastErrorText())
    sys.exit()

# Get the text response.
sbResponse = chilkat.CkStringBuilder()
ai.GetOutputTextSb(sbResponse)
print(sbResponse.getAsString())

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

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