OpenAI SDK: Use the Azure deployment relevant to a specific model namev3.6+
Configure a header capture to insert the requested model name directly into the plugin configuration for Kong AI Gateway deployment with Azure OpenAI, as a string substitution.
For this plugin to work properly, you need a Route with the following configuration:
routes: - name: azure-chat-model-from-path paths: - "~/azure/.*" methods: - POSTCopied!
Using the below configuration, you can target an Azure model deployment named west-europe-gpt-4o with the following sample request:
cat <<EOF > request.json
{
"messages": [
{
"role": "user",
"content": [
{
"type": "text",
"text": "This is my question."
}
]
}
]
}
EOF
curl http://localhost:8000/1/chat/completions \
-H "x-test: azure-chat-open-model-managed-identity" \
-H "x-model-name: gpt-4o" \
-d @request.json
Prerequisites
- Azure OpenAI Service account
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: ai-proxy
config:
auth:
azure_use_managed_identity: true
model:
provider: azure
model: "$(headers.x-model-name)"
options:
azure_instance: llm-deployment-v1
azure_deployment_id: west-europe-$(headers.x-model-name)
azure_api_version: '2024-10-01'
Make the following request:
curl -i -X POST http://localhost:8001/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "ai-proxy",
"config": {
"auth": {
"azure_use_managed_identity": true
},
"model": {
"provider": "azure",
"model": "$(headers.x-model-name)",
"options": {
"azure_instance": "llm-deployment-v1",
"azure_deployment_id": "west-europe-$(headers.x-model-name)",
"azure_api_version": "2024-10-01"
}
}
},
"tags": []
}
'
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "ai-proxy",
"config": {
"auth": {
"azure_use_managed_identity": true
},
"model": {
"provider": "azure",
"model": "$(headers.x-model-name)",
"options": {
"azure_instance": "llm-deployment-v1",
"azure_deployment_id": "west-europe-$(headers.x-model-name)",
"azure_api_version": "2024-10-01"
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
name: ai-proxy
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
labels:
global: 'true'
config:
auth:
azure_use_managed_identity: true
model:
provider: azure
model: '$(headers.x-model-name)'
options:
azure_instance: llm-deployment-v1
azure_deployment_id: west-europe-$(headers.x-model-name)
azure_api_version: '2024-10-01'
plugin: ai-proxy
" | kubectl apply -f -
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_ai_proxy" "my_ai_proxy" {
enabled = true
config = {
auth = {
azure_use_managed_identity = true
}
model = {
provider = "azure"
model = "$(headers.x-model-name)"
options = {
azure_instance = "llm-deployment-v1"
azure_deployment_id = "west-europe-$(headers.x-model-name)"
azure_api_version = "2024-10-01"
}
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: ai-proxy
service: serviceName|Id
config:
auth:
azure_use_managed_identity: true
model:
provider: azure
model: "$(headers.x-model-name)"
options:
azure_instance: llm-deployment-v1
azure_deployment_id: west-europe-$(headers.x-model-name)
azure_api_version: '2024-10-01'
Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "ai-proxy",
"config": {
"auth": {
"azure_use_managed_identity": true
},
"model": {
"provider": "azure",
"model": "$(headers.x-model-name)",
"options": {
"azure_instance": "llm-deployment-v1",
"azure_deployment_id": "west-europe-$(headers.x-model-name)",
"azure_api_version": "2024-10-01"
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
serviceName|Id: Theidornameof the service the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "ai-proxy",
"config": {
"auth": {
"azure_use_managed_identity": true
},
"model": {
"provider": "azure",
"model": "$(headers.x-model-name)",
"options": {
"azure_instance": "llm-deployment-v1",
"azure_deployment_id": "west-europe-$(headers.x-model-name)",
"azure_api_version": "2024-10-01"
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
serviceId: Theidof the service the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: ai-proxy
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
auth:
azure_use_managed_identity: true
model:
provider: azure
model: '$(headers.x-model-name)'
options:
azure_instance: llm-deployment-v1
azure_deployment_id: west-europe-$(headers.x-model-name)
azure_api_version: '2024-10-01'
plugin: ai-proxy
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the service resource:
kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=ai-proxy
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_ai_proxy" "my_ai_proxy" {
enabled = true
config = {
auth = {
azure_use_managed_identity = true
}
model = {
provider = "azure"
model = "$(headers.x-model-name)"
options = {
azure_instance = "llm-deployment-v1"
azure_deployment_id = "west-europe-$(headers.x-model-name)"
azure_api_version = "2024-10-01"
}
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
service = {
id = konnect_gateway_service.my_service.id
}
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: ai-proxy
route: routeName|Id
config:
auth:
azure_use_managed_identity: true
model:
provider: azure
model: "$(headers.x-model-name)"
options:
azure_instance: llm-deployment-v1
azure_deployment_id: west-europe-$(headers.x-model-name)
azure_api_version: '2024-10-01'
Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "ai-proxy",
"config": {
"auth": {
"azure_use_managed_identity": true
},
"model": {
"provider": "azure",
"model": "$(headers.x-model-name)",
"options": {
"azure_instance": "llm-deployment-v1",
"azure_deployment_id": "west-europe-$(headers.x-model-name)",
"azure_api_version": "2024-10-01"
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
routeName|Id: Theidornameof the route the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "ai-proxy",
"config": {
"auth": {
"azure_use_managed_identity": true
},
"model": {
"provider": "azure",
"model": "$(headers.x-model-name)",
"options": {
"azure_instance": "llm-deployment-v1",
"azure_deployment_id": "west-europe-$(headers.x-model-name)",
"azure_api_version": "2024-10-01"
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
routeId: Theidof the route the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: ai-proxy
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
auth:
azure_use_managed_identity: true
model:
provider: azure
model: '$(headers.x-model-name)'
options:
azure_instance: llm-deployment-v1
azure_deployment_id: west-europe-$(headers.x-model-name)
azure_api_version: '2024-10-01'
plugin: ai-proxy
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the httproute or ingress resource:
kubectl annotate -n kong httproute konghq.com/plugins=ai-proxy
kubectl annotate -n kong ingress konghq.com/plugins=ai-proxy
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_ai_proxy" "my_ai_proxy" {
enabled = true
config = {
auth = {
azure_use_managed_identity = true
}
model = {
provider = "azure"
model = "$(headers.x-model-name)"
options = {
azure_instance = "llm-deployment-v1"
azure_deployment_id = "west-europe-$(headers.x-model-name)"
azure_api_version = "2024-10-01"
}
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
route = {
id = konnect_gateway_route.my_route.id
}
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: ai-proxy
consumer: consumerName|Id
config:
auth:
azure_use_managed_identity: true
model:
provider: azure
model: "$(headers.x-model-name)"
options:
azure_instance: llm-deployment-v1
azure_deployment_id: west-europe-$(headers.x-model-name)
azure_api_version: '2024-10-01'
Make sure to replace the following placeholders with your own values:
-
consumerName|Id: Theidornameof the consumer the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "ai-proxy",
"config": {
"auth": {
"azure_use_managed_identity": true
},
"model": {
"provider": "azure",
"model": "$(headers.x-model-name)",
"options": {
"azure_instance": "llm-deployment-v1",
"azure_deployment_id": "west-europe-$(headers.x-model-name)",
"azure_api_version": "2024-10-01"
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
consumerName|Id: Theidornameof the consumer the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "ai-proxy",
"config": {
"auth": {
"azure_use_managed_identity": true
},
"model": {
"provider": "azure",
"model": "$(headers.x-model-name)",
"options": {
"azure_instance": "llm-deployment-v1",
"azure_deployment_id": "west-europe-$(headers.x-model-name)",
"azure_api_version": "2024-10-01"
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
consumerId: Theidof the consumer the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: ai-proxy
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
auth:
azure_use_managed_identity: true
model:
provider: azure
model: '$(headers.x-model-name)'
options:
azure_instance: llm-deployment-v1
azure_deployment_id: west-europe-$(headers.x-model-name)
azure_api_version: '2024-10-01'
plugin: ai-proxy
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the KongConsumer resource:
kubectl annotate -n kong CONSUMER_NAME konghq.com/plugins=ai-proxy
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_ai_proxy" "my_ai_proxy" {
enabled = true
config = {
auth = {
azure_use_managed_identity = true
}
model = {
provider = "azure"
model = "$(headers.x-model-name)"
options = {
azure_instance = "llm-deployment-v1"
azure_deployment_id = "west-europe-$(headers.x-model-name)"
azure_api_version = "2024-10-01"
}
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer = {
id = konnect_gateway_consumer.my_consumer.id
}
}
Add this section to your kong.yaml configuration file:
_format_version: "3.0"
plugins:
- name: ai-proxy
consumer_group: consumerGroupName|Id
config:
auth:
azure_use_managed_identity: true
model:
provider: azure
model: "$(headers.x-model-name)"
options:
azure_instance: llm-deployment-v1
azure_deployment_id: west-europe-$(headers.x-model-name)
azure_api_version: '2024-10-01'
Make sure to replace the following placeholders with your own values:
-
consumerGroupName|Id: Theidornameof the consumer group the plugin configuration will target.
Make the following request:
curl -i -X POST http://localhost:8001/consumer_groups/{consumerGroupName|Id}/plugins/ \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--data '
{
"name": "ai-proxy",
"config": {
"auth": {
"azure_use_managed_identity": true
},
"model": {
"provider": "azure",
"model": "$(headers.x-model-name)",
"options": {
"azure_instance": "llm-deployment-v1",
"azure_deployment_id": "west-europe-$(headers.x-model-name)",
"azure_api_version": "2024-10-01"
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
consumerGroupName|Id: Theidornameof the consumer group the plugin configuration will target.
Make the following request:
curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{consumerGroupId}/plugins/ \
--header "accept: application/json" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer $KONNECT_TOKEN" \
--data '
{
"name": "ai-proxy",
"config": {
"auth": {
"azure_use_managed_identity": true
},
"model": {
"provider": "azure",
"model": "$(headers.x-model-name)",
"options": {
"azure_instance": "llm-deployment-v1",
"azure_deployment_id": "west-europe-$(headers.x-model-name)",
"azure_api_version": "2024-10-01"
}
}
},
"tags": []
}
'
Make sure to replace the following placeholders with your own values:
-
region: Geographic region where your Kong Konnect is hosted and operates. -
controlPlaneId: Theidof the control plane. -
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account. -
consumerGroupId: Theidof the consumer group the plugin configuration will target.
See the Konnect API reference to learn about region-specific URLs and personal access tokens.
echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
name: ai-proxy
namespace: kong
annotations:
kubernetes.io/ingress.class: kong
konghq.com/tags: ''
config:
auth:
azure_use_managed_identity: true
model:
provider: azure
model: '$(headers.x-model-name)'
options:
azure_instance: llm-deployment-v1
azure_deployment_id: west-europe-$(headers.x-model-name)
azure_api_version: '2024-10-01'
plugin: ai-proxy
" | kubectl apply -f -
Next, apply the KongPlugin resource by annotating the KongConsumerGroup resource:
kubectl annotate -n kong CONSUMERGROUP_NAME konghq.com/plugins=ai-proxy
Prerequisite: Configure your Personal Access Token
terraform {
required_providers {
konnect = {
source = "kong/konnect"
}
}
}
provider "konnect" {
personal_access_token = "$KONNECT_TOKEN"
server_url = "https://us.api.konghq.com/"
}
Add the following to your Terraform configuration to create a Konnect Gateway Plugin:
resource "konnect_gateway_plugin_ai_proxy" "my_ai_proxy" {
enabled = true
config = {
auth = {
azure_use_managed_identity = true
}
model = {
provider = "azure"
model = "$(headers.x-model-name)"
options = {
azure_instance = "llm-deployment-v1"
azure_deployment_id = "west-europe-$(headers.x-model-name)"
azure_api_version = "2024-10-01"
}
}
}
tags = []
control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
consumer_group = {
id = konnect_gateway_consumer_group.my_consumer_group.id
}
}