AI Request Transformer: Add data to a request body - Plugin

Add data to a request bodyv3.6+

Configure the plugin to use OpenAI GPT-4 to add an element to the client request body before proxying it. See Transform a request body using OpenAI for a full how-to guide with this example.

Prerequisites

You have an OpenAI subscription.

Environment variables

OPENAI_API_KEY: An API key to connect to the OpenAI API.

Set up the plugin

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ai-request-transformer
    config:
      prompt: In my JSON message, anywhere there is a JSON tag for a city, also add
        a country tag with the name of the country that city is in.
      transformation_extract_pattern: "{((.|\\n)*)}"
      llm:
        route_type: llm/v1/chat
        auth:
          header_name: Authorization
          header_value: Bearer ${{ env "DECK_OPENAI_API_KEY" }}
        model:
          provider: openai
          name: gpt-4

Make the following request:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "ai-request-transformer",
      "config": {
        "prompt": "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in.",
        "transformation_extract_pattern": "{((.|\\n)*)}",
        "llm": {
          "route_type": "llm/v1/chat",
          "auth": {
            "header_name": "Authorization",
            "header_value": "Bearer '$OPENAI_API_KEY'"
          },
          "model": {
            "provider": "openai",
            "name": "gpt-4"
          }
        }
      }
    }
    '

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-request-transformer",
      "config": {
        "prompt": "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in.",
        "transformation_extract_pattern": "{((.|\\n)*)}",
        "llm": {
          "route_type": "llm/v1/chat",
          "auth": {
            "header_name": "Authorization",
            "header_value": "Bearer '$OPENAI_API_KEY'"
          },
          "model": {
            "provider": "openai",
            "name": "gpt-4"
          }
        }
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of 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-request-transformer
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: 'true'
config:
  prompt: In my JSON message, anywhere there is a JSON tag for a city, also add a
    country tag with the name of the country that city is in.
  transformation_extract_pattern: '{((.|\\n)*)}'
  llm:
    route_type: llm/v1/chat
    auth:
      header_name: Authorization
      header_value: Bearer $OPENAI_API_KEY
    model:
      provider: openai
      name: gpt-4
plugin: ai-request-transformer
" | 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_request_transformer" "my_ai_request_transformer" {
  enabled = true

  config = {
    prompt = "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in."
    transformation_extract_pattern = "{((.|\n)*)}"

    llm = {
      route_type = "llm/v1/chat"

      auth = {
        header_name = "Authorization"
        header_value = "Bearer var.openai_api_key"
      }

      model = {
        provider = "openai"
        name = "gpt-4"
      }
    }
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "openai_api_key" {
  type = string
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ai-request-transformer
    service: serviceName|Id
    config:
      prompt: In my JSON message, anywhere there is a JSON tag for a city, also add
        a country tag with the name of the country that city is in.
      transformation_extract_pattern: "{((.|\\n)*)}"
      llm:
        route_type: llm/v1/chat
        auth:
          header_name: Authorization
          header_value: Bearer ${{ env "DECK_OPENAI_API_KEY" }}
        model:
          provider: openai
          name: gpt-4

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of 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-request-transformer",
      "config": {
        "prompt": "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in.",
        "transformation_extract_pattern": "{((.|\\n)*)}",
        "llm": {
          "route_type": "llm/v1/chat",
          "auth": {
            "header_name": "Authorization",
            "header_value": "Bearer '$OPENAI_API_KEY'"
          },
          "model": {
            "provider": "openai",
            "name": "gpt-4"
          }
        }
      }
    }
    '

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of 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-request-transformer",
      "config": {
        "prompt": "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in.",
        "transformation_extract_pattern": "{((.|\\n)*)}",
        "llm": {
          "route_type": "llm/v1/chat",
          "auth": {
            "header_name": "Authorization",
            "header_value": "Bearer '$OPENAI_API_KEY'"
          },
          "model": {
            "provider": "openai",
            "name": "gpt-4"
          }
        }
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
serviceId: The id of 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-request-transformer
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  prompt: In my JSON message, anywhere there is a JSON tag for a city, also add a
    country tag with the name of the country that city is in.
  transformation_extract_pattern: '{((.|\\n)*)}'
  llm:
    route_type: llm/v1/chat
    auth:
      header_name: Authorization
      header_value: Bearer $OPENAI_API_KEY
    model:
      provider: openai
      name: gpt-4
plugin: ai-request-transformer
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the service resource:

kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=ai-request-transformer

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_request_transformer" "my_ai_request_transformer" {
  enabled = true

  config = {
    prompt = "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in."
    transformation_extract_pattern = "{((.|\n)*)}"

    llm = {
      route_type = "llm/v1/chat"

      auth = {
        header_name = "Authorization"
        header_value = "Bearer var.openai_api_key"
      }

      model = {
        provider = "openai"
        name = "gpt-4"
      }
    }
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  service = {
    id = konnect_gateway_service.my_service.id
  }
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "openai_api_key" {
  type = string
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ai-request-transformer
    route: routeName|Id
    config:
      prompt: In my JSON message, anywhere there is a JSON tag for a city, also add
        a country tag with the name of the country that city is in.
      transformation_extract_pattern: "{((.|\\n)*)}"
      llm:
        route_type: llm/v1/chat
        auth:
          header_name: Authorization
          header_value: Bearer ${{ env "DECK_OPENAI_API_KEY" }}
        model:
          provider: openai
          name: gpt-4

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of 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-request-transformer",
      "config": {
        "prompt": "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in.",
        "transformation_extract_pattern": "{((.|\\n)*)}",
        "llm": {
          "route_type": "llm/v1/chat",
          "auth": {
            "header_name": "Authorization",
            "header_value": "Bearer '$OPENAI_API_KEY'"
          },
          "model": {
            "provider": "openai",
            "name": "gpt-4"
          }
        }
      }
    }
    '

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of 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-request-transformer",
      "config": {
        "prompt": "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in.",
        "transformation_extract_pattern": "{((.|\\n)*)}",
        "llm": {
          "route_type": "llm/v1/chat",
          "auth": {
            "header_name": "Authorization",
            "header_value": "Bearer '$OPENAI_API_KEY'"
          },
          "model": {
            "provider": "openai",
            "name": "gpt-4"
          }
        }
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
routeId: The id of 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-request-transformer
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  prompt: In my JSON message, anywhere there is a JSON tag for a city, also add a
    country tag with the name of the country that city is in.
  transformation_extract_pattern: '{((.|\\n)*)}'
  llm:
    route_type: llm/v1/chat
    auth:
      header_name: Authorization
      header_value: Bearer $OPENAI_API_KEY
    model:
      provider: openai
      name: gpt-4
plugin: ai-request-transformer
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the httproute or ingress resource:

kubectl annotate -n kong httproute  konghq.com/plugins=ai-request-transformer

kubectl annotate -n kong ingress  konghq.com/plugins=ai-request-transformer

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_request_transformer" "my_ai_request_transformer" {
  enabled = true

  config = {
    prompt = "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in."
    transformation_extract_pattern = "{((.|\n)*)}"

    llm = {
      route_type = "llm/v1/chat"

      auth = {
        header_name = "Authorization"
        header_value = "Bearer var.openai_api_key"
      }

      model = {
        provider = "openai"
        name = "gpt-4"
      }
    }
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  route = {
    id = konnect_gateway_route.my_route.id
  }
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "openai_api_key" {
  type = string
}

Add this section to your declarative configuration file:

_format_version: "3.0"
plugins:
  - name: ai-request-transformer
    consumer_group: consumerGroupName|Id
    config:
      prompt: In my JSON message, anywhere there is a JSON tag for a city, also add
        a country tag with the name of the country that city is in.
      transformation_extract_pattern: "{((.|\\n)*)}"
      llm:
        route_type: llm/v1/chat
        auth:
          header_name: Authorization
          header_value: Bearer ${{ env "DECK_OPENAI_API_KEY" }}
        model:
          provider: openai
          name: gpt-4

Make sure to replace the following placeholders with your own values:

consumerGroupName|Id: The id or name of 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-request-transformer",
      "config": {
        "prompt": "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in.",
        "transformation_extract_pattern": "{((.|\\n)*)}",
        "llm": {
          "route_type": "llm/v1/chat",
          "auth": {
            "header_name": "Authorization",
            "header_value": "Bearer '$OPENAI_API_KEY'"
          },
          "model": {
            "provider": "openai",
            "name": "gpt-4"
          }
        }
      }
    }
    '

Make sure to replace the following placeholders with your own values:

consumerGroupName|Id: The id or name of 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-request-transformer",
      "config": {
        "prompt": "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in.",
        "transformation_extract_pattern": "{((.|\\n)*)}",
        "llm": {
          "route_type": "llm/v1/chat",
          "auth": {
            "header_name": "Authorization",
            "header_value": "Bearer '$OPENAI_API_KEY'"
          },
          "model": {
            "provider": "openai",
            "name": "gpt-4"
          }
        }
      }
    }
    '

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
controlPlaneId: The id of the control plane.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
consumerGroupId: The id of 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-request-transformer
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  prompt: In my JSON message, anywhere there is a JSON tag for a city, also add a
    country tag with the name of the country that city is in.
  transformation_extract_pattern: '{((.|\\n)*)}'
  llm:
    route_type: llm/v1/chat
    auth:
      header_name: Authorization
      header_value: Bearer $OPENAI_API_KEY
    model:
      provider: openai
      name: gpt-4
plugin: ai-request-transformer
" | kubectl apply -f -

Next, apply the KongPlugin resource by annotating the KongConsumerGroup resource:

kubectl annotate -n kong  CONSUMERGROUP_NAME konghq.com/plugins=ai-request-transformer

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_request_transformer" "my_ai_request_transformer" {
  enabled = true

  config = {
    prompt = "In my JSON message, anywhere there is a JSON tag for a city, also add a country tag with the name of the country that city is in."
    transformation_extract_pattern = "{((.|\n)*)}"

    llm = {
      route_type = "llm/v1/chat"

      auth = {
        header_name = "Authorization"
        header_value = "Bearer var.openai_api_key"
      }

      model = {
        provider = "openai"
        name = "gpt-4"
      }
    }
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer_group = {
    id = konnect_gateway_consumer_group.my_consumer_group.id
  }
}

This example requires the following variables to be added to your manifest. You can specify values at runtime by setting TF_VAR_name=value.

variable "openai_api_key" {
  type = string
}

AI Request Transformer

Add data to a request bodyv3.6+

Prerequisites

Environment variables

Set up the plugin

Help us make these docs great!

Still need help