Basic config examples for AI Prompt Template - Plugin - v3.7.x

You are browsing documentation for an outdated plugin version.

Basic configuration examples

Enable on a service

Enable on a route

Enable on a consumer group

Enable globally

The following examples provide some typical configurations for enabling the ai-prompt-template plugin on a service.

Kong Admin API

Konnect API

Kubernetes

Declarative (YAML)

Konnect Terraform

Make the following request:

curl -X POST http://localhost:8001/services/{serviceName|Id}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "ai-prompt-template",
  "config": {
    "allow_untemplated_requests": true,
    "templates": [
      {
        "name": "developer-chat",
        "template": "{\n  \"messages\": [\n    {\n      \"role\": \"system\",\n      \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n      \"role\": \"user\",\n      \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
      },
      {
        "name": "summarize-prompt",
        "template": "{\n  \"prompt\": \"Summarize the following text for me: {{text}}\"\n}"
      }
    ]
  }
}
    '

Replace SERVICE_NAME|ID with the id or name of the service that this plugin configuration will target.

Make the following request, substituting your own access token, region, control plane ID, and service ID:

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"ai-prompt-template","config":{"allow_untemplated_requests":true,"templates":[{"name":"developer-chat","template":"{\n  \"messages\": [\n    {\n      \"role\": \"system\",\n      \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n      \"role\": \"user\",\n      \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"},{"name":"summarize-prompt","template":"{\n  \"prompt\": \"Summarize the following text for me: {{text}}\"\n}"}]}}'

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: ai-prompt-template-example
plugin: ai-prompt-template
config:
  allow_untemplated_requests: true
  templates:
  - name: developer-chat
    template: |-
      {
        "messages": [
          {
            "role": "system",
            "content": "You are a {{program}} expert, in {{language}} programming language."
          },
          {
            "role": "user",
            "content": "Write me a {{program}} program."
          }
        ]
      }
  - name: summarize-prompt
    template: |-
      {
        "prompt": "Summarize the following text for me: {{text}}"
      }
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the service as follows:

kubectl annotate service SERVICE_NAME konghq.com/plugins=ai-prompt-template-example

Replace SERVICE_NAME with the name of the service that this plugin configuration will target. You can see your available ingresses by running kubectl get service.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: ai-prompt-template
  service: SERVICE_NAME|ID
  config:
    allow_untemplated_requests: true
    templates:
    - name: developer-chat
      template: |-
        {
          "messages": [
            {
              "role": "system",
              "content": "You are a {{program}} expert, in {{language}} programming language."
            },
            {
              "role": "user",
              "content": "Write me a {{program}} program."
            }
          ]
        }
    - name: summarize-prompt
      template: |-
        {
          "prompt": "Summarize the following text for me: {{text}}"
        }

Replace SERVICE_NAME|ID with the id or name of the service that this plugin configuration will target.

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "kpat_YOUR_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_prompt_template" "my_ai_prompt_template" {
  enabled = true

  config = {
    allow_untemplated_requests = true
    templates = [
      {
        name = "developer-chat"
        template = <<EOF
{
  "messages": [
    {
      "role": "system",
      "content": "You are a {{program}} expert, in {{language}} programming language."
    },
    {
      "role": "user",
      "content": "Write me a {{program}} program."
    }
  ]
}
EOF
      }, 

      {
        name = "summarize-prompt"
        template = <<EOF
{
  "prompt": "Summarize the following text for me: {{text}}"
}
EOF
      }    ]
  }

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

The following examples provide some typical configurations for enabling the ai-prompt-template plugin on a route.

Kong Admin API

Konnect API

Kubernetes

Declarative (YAML)

Konnect Terraform

Make the following request:

curl -X POST http://localhost:8001/routes/{routeName|Id}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "ai-prompt-template",
  "config": {
    "allow_untemplated_requests": true,
    "templates": [
      {
        "name": "developer-chat",
        "template": "{\n  \"messages\": [\n    {\n      \"role\": \"system\",\n      \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n      \"role\": \"user\",\n      \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
      },
      {
        "name": "summarize-prompt",
        "template": "{\n  \"prompt\": \"Summarize the following text for me: {{text}}\"\n}"
      }
    ]
  }
}
    '

Replace ROUTE_NAME|ID with the id or name of the route that this plugin configuration will target.

Make the following request, substituting your own access token, region, control plane ID, and route ID:

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"ai-prompt-template","config":{"allow_untemplated_requests":true,"templates":[{"name":"developer-chat","template":"{\n  \"messages\": [\n    {\n      \"role\": \"system\",\n      \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n      \"role\": \"user\",\n      \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"},{"name":"summarize-prompt","template":"{\n  \"prompt\": \"Summarize the following text for me: {{text}}\"\n}"}]}}'

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: ai-prompt-template-example
plugin: ai-prompt-template
config:
  allow_untemplated_requests: true
  templates:
  - name: developer-chat
    template: |-
      {
        "messages": [
          {
            "role": "system",
            "content": "You are a {{program}} expert, in {{language}} programming language."
          },
          {
            "role": "user",
            "content": "Write me a {{program}} program."
          }
        ]
      }
  - name: summarize-prompt
    template: |-
      {
        "prompt": "Summarize the following text for me: {{text}}"
      }
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the ingress as follows:

kubectl annotate ingress INGRESS_NAME konghq.com/plugins=ai-prompt-template-example

Replace INGRESS_NAME with the name of the ingress that this plugin configuration will target. You can see your available ingresses by running kubectl get ingress.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: ai-prompt-template
  route: ROUTE_NAME|ID
  config:
    allow_untemplated_requests: true
    templates:
    - name: developer-chat
      template: |-
        {
          "messages": [
            {
              "role": "system",
              "content": "You are a {{program}} expert, in {{language}} programming language."
            },
            {
              "role": "user",
              "content": "Write me a {{program}} program."
            }
          ]
        }
    - name: summarize-prompt
      template: |-
        {
          "prompt": "Summarize the following text for me: {{text}}"
        }

Replace ROUTE_NAME|ID with the id or name of the route that this plugin configuration will target.

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "kpat_YOUR_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_prompt_template" "my_ai_prompt_template" {
  enabled = true

  config = {
    allow_untemplated_requests = true
    templates = [
      {
        name = "developer-chat"
        template = <<EOF
{
  "messages": [
    {
      "role": "system",
      "content": "You are a {{program}} expert, in {{language}} programming language."
    },
    {
      "role": "user",
      "content": "Write me a {{program}} program."
    }
  ]
}
EOF
      }, 

      {
        name = "summarize-prompt"
        template = <<EOF
{
  "prompt": "Summarize the following text for me: {{text}}"
}
EOF
      }    ]
  }

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

The following examples provide some typical configurations for enabling the ai-prompt-template plugin on a consumer group.

Kong Admin API

Konnect API

Kubernetes

Declarative (YAML)

Konnect Terraform

Make the following request:

curl -X POST http://localhost:8001/consumer_groups/{consumerGroupName|Id}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "ai-prompt-template",
  "config": {
    "allow_untemplated_requests": true,
    "templates": [
      {
        "name": "developer-chat",
        "template": "{\n  \"messages\": [\n    {\n      \"role\": \"system\",\n      \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n      \"role\": \"user\",\n      \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
      },
      {
        "name": "summarize-prompt",
        "template": "{\n  \"prompt\": \"Summarize the following text for me: {{text}}\"\n}"
      }
    ]
  }
}
    '

Replace CONSUMER_GROUP_NAME|ID with the id or name of the consumer group that this plugin configuration will target.

Make the following request, substituting your own access token, region, control plane ID, and consumer group ID:

curl -X POST \
https://{us|eu}.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 TOKEN" \
    --data '{"name":"ai-prompt-template","config":{"allow_untemplated_requests":true,"templates":[{"name":"developer-chat","template":"{\n  \"messages\": [\n    {\n      \"role\": \"system\",\n      \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n      \"role\": \"user\",\n      \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"},{"name":"summarize-prompt","template":"{\n  \"prompt\": \"Summarize the following text for me: {{text}}\"\n}"}]}}'

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: ai-prompt-template-example
plugin: ai-prompt-template
config:
  allow_untemplated_requests: true
  templates:
  - name: developer-chat
    template: |-
      {
        "messages": [
          {
            "role": "system",
            "content": "You are a {{program}} expert, in {{language}} programming language."
          },
          {
            "role": "user",
            "content": "Write me a {{program}} program."
          }
        ]
      }
  - name: summarize-prompt
    template: |-
      {
        "prompt": "Summarize the following text for me: {{text}}"
      }
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the KongConsumerGroup object as follows:

kubectl annotate KongConsumerGroup CONSUMER_GROUP_NAME konghq.com/plugins=ai-prompt-template-example

Replace CONSUMER_GROUP_NAME with the name of the consumer group that this plugin configuration will target. You can see your available consumer groups by running kubectl get KongConsumerGroup.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, consumer group, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: ai-prompt-template
  consumer_group: CONSUMER_GROUP_NAME|ID
  config:
    allow_untemplated_requests: true
    templates:
    - name: developer-chat
      template: |-
        {
          "messages": [
            {
              "role": "system",
              "content": "You are a {{program}} expert, in {{language}} programming language."
            },
            {
              "role": "user",
              "content": "Write me a {{program}} program."
            }
          ]
        }
    - name: summarize-prompt
      template: |-
        {
          "prompt": "Summarize the following text for me: {{text}}"
        }

Replace CONSUMER_GROUP_NAME|ID with the id or name of the consumer group that this plugin configuration will target.

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "kpat_YOUR_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_prompt_template" "my_ai_prompt_template" {
  enabled = true

  config = {
    allow_untemplated_requests = true
    templates = [
      {
        name = "developer-chat"
        template = <<EOF
{
  "messages": [
    {
      "role": "system",
      "content": "You are a {{program}} expert, in {{language}} programming language."
    },
    {
      "role": "user",
      "content": "Write me a {{program}} program."
    }
  ]
}
EOF
      }, 

      {
        name = "summarize-prompt"
        template = <<EOF
{
  "prompt": "Summarize the following text for me: {{text}}"
}
EOF
      }    ]
  }

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

A plugin which is not associated to any service, route, consumer, or consumer group is considered global, and will be run on every request.

In self-managed Kong Gateway Enterprise, the plugin applies to every entity in a given workspace.
In self-managed Kong Gateway (OSS), the plugin applies to your entire environment.
In Konnect, the plugin applies to every entity in a given control plane.

Read the Plugin Reference and the Plugin Precedence sections for more information.

The following examples provide some typical configurations for enabling the AI Prompt Template plugin globally.

Kong Admin API

Konnect API

Kubernetes

Declarative (YAML)

Konnect Terraform

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
  "name": "ai-prompt-template",
  "config": {
    "allow_untemplated_requests": true,
    "templates": [
      {
        "name": "developer-chat",
        "template": "{\n  \"messages\": [\n    {\n      \"role\": \"system\",\n      \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n      \"role\": \"user\",\n      \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"
      },
      {
        "name": "summarize-prompt",
        "template": "{\n  \"prompt\": \"Summarize the following text for me: {{text}}\"\n}"
      }
    ]
  }
}
    '

Make the following request, substituting your own access token, region, and control plane ID:

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"ai-prompt-template","config":{"allow_untemplated_requests":true,"templates":[{"name":"developer-chat","template":"{\n  \"messages\": [\n    {\n      \"role\": \"system\",\n      \"content\": \"You are a {{program}} expert, in {{language}} programming language.\"\n    },\n    {\n      \"role\": \"user\",\n      \"content\": \"Write me a {{program}} program.\"\n    }\n  ]\n}"},{"name":"summarize-prompt","template":"{\n  \"prompt\": \"Summarize the following text for me: {{text}}\"\n}"}]}}'

See the Konnect API reference to learn about region-specific URLs and personal access tokens.

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-ai-prompt-template>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: "true"
config:
  allow_untemplated_requests: true
  templates:
  - name: developer-chat
    template: |-
      {
        "messages": [
          {
            "role": "system",
            "content": "You are a {{program}} expert, in {{language}} programming language."
          },
          {
            "role": "user",
            "content": "Write me a {{program}} program."
          }
        ]
      }
  - name: summarize-prompt
    template: |-
      {
        "prompt": "Summarize the following text for me: {{text}}"
      }
plugin: ai-prompt-template

Add a plugins entry in the declarative configuration file:

plugins:
- name: ai-prompt-template
  config:
    allow_untemplated_requests: true
    templates:
    - name: developer-chat
      template: |-
        {
          "messages": [
            {
              "role": "system",
              "content": "You are a {{program}} expert, in {{language}} programming language."
            },
            {
              "role": "user",
              "content": "Write me a {{program}} program."
            }
          ]
        }
    - name: summarize-prompt
      template: |-
        {
          "prompt": "Summarize the following text for me: {{text}}"
        }

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "kpat_YOUR_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_prompt_template" "my_ai_prompt_template" {
  enabled = true

  config = {
    allow_untemplated_requests = true
    templates = [
      {
        name = "developer-chat"
        template = <<EOF
{
  "messages": [
    {
      "role": "system",
      "content": "You are a {{program}} expert, in {{language}} programming language."
    },
    {
      "role": "user",
      "content": "Write me a {{program}} program."
    }
  ]
}
EOF
      }, 

      {
        name = "summarize-prompt"
        template = <<EOF
{
  "prompt": "Summarize the following text for me: {{text}}"
}
EOF
      }    ]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

Previous AI Prompt Template Configuration

Next Using the AI Prompt Template plugin