Provide AI prompt templates for end users with the AI Prompt Template plugin and Mistral

Uses: Kong Gateway AI Gateway deck
Tags
Minimum Version
Kong Gateway - 3.6
TL;DR

Configure the AI Proxy plugin to route traffic, then use the AI Prompt Template plugin to define and enforce reusable prompt formats.

Prerequisites

This is a Konnect tutorial and requires a Konnect personal access token.

  1. Create a new personal access token by opening the Konnect PAT page and selecting Generate Token.

  2. Export your token to an environment variable:

     export KONNECT_TOKEN='YOUR_KONNECT_PAT'
    
  3. Run the quickstart script to automatically provision a Control Plane and Data Plane, and configure your environment:

     curl -Ls https://get.konghq.com/quickstart | bash -s -- -k $KONNECT_TOKEN --deck-output
    

    This sets up a Konnect Control Plane named quickstart, provisions a local Data Plane, and prints out the following environment variable exports:

     export DECK_KONNECT_TOKEN=$KONNECT_TOKEN
     export DECK_KONNECT_CONTROL_PLANE_NAME=quickstart
     export KONNECT_CONTROL_PLANE_URL=https://us.api.konghq.com
     export KONNECT_PROXY_URL='http://localhost:8000'
    

    Copy and paste these into your terminal to configure your session.

This tutorial requires Kong Gateway Enterprise. If you don’t have Kong Gateway set up yet, you can use the quickstart script with an enterprise license to get an instance of Kong Gateway running almost instantly.

  1. Export your license to an environment variable:

     export KONG_LICENSE_DATA='LICENSE-CONTENTS-GO-HERE'
    
  2. Run the quickstart script:

    curl -Ls https://get.konghq.com/quickstart | bash -s -- -e KONG_LICENSE_DATA 
    

    Once Kong Gateway is ready, you will see the following message:

     Kong Gateway Ready
    

decK is a CLI tool for managing Kong Gateway declaratively with state files. To complete this tutorial you will first need to install decK.

For this tutorial, you’ll need Kong Gateway entities, like Gateway Services and Routes, pre-configured. These entities are essential for Kong Gateway to function but installing them isn’t the focus of this guide. Follow these steps to pre-configure them:

  1. Run the following command:

    echo '
    _format_version: "3.0"
    services:
      - name: example-service
        url: http://httpbin.konghq.com/anything
    routes:
      - name: example-route
        paths:
        - "/anything"
        service:
          name: example-service
    ' | deck gateway apply -
    

To learn more about entities, you can read our entities documentation.

This tutorial uses Mistral:

  1. Create a Mistral account.
  2. Get your API key.
  3. Export a decK environment variable with the Mistral API key:
export DECK_MISTRAL_API_KEY='YOUR MISTRAL API KEY'

Configure the AI Proxy plugin

Start by configuring the AI Proxy plugin to route prompts to Mistral AI.

echo '
_format_version: "3.0"
plugins:
  - name: ai-proxy
    config:
      route_type: llm/v1/chat
      auth:
        header_name: Authorization
        header_value: Bearer ${{ env "DECK_MISTRAL_API_KEY" }}
      model:
        provider: mistral
        name: mistral-tiny
        options:
          mistral_format: openai
          upstream_url: https://api.mistral.ai/v1/chat/completions
' | deck gateway apply -

Configure the AI Prompt Template plugin

Now, we can configure the AI Prompt Template plugin with predefined, reusable prompt templates for common tasks. This allows users to fill in the blanks with variable placeholders (``).

The plugin will automatically block all untemplated requests via allow_untemplated_requests: false setting.

This configuration defines five prompt templates:

Template name

Description

summarizer Summarizes long text into concise bullet points.
code-explainer Explains source code in beginner-friendly terms.
email-drafter Drafts professional emails based on topic and recipient.
product-describer Generates marketing descriptions from product details and features.
qna Answers user questions clearly and factually.

Configure the AI Prompt Template plugin:

echo '
_format_version: "3.0"
plugins:
  - name: ai-prompt-template
    config:
      allow_untemplated_requests: false
      templates:
      - name: summarizer
        template: |-
          {
              "messages": [
                {
                  "role": "system",
                  "content": "You summarize long texts into concise bullet points."
                },
                {
                  "role": "user",
                  "content": "Summarize the following text: {{text}}"
                }
              ]
          }
      - name: code-explainer
        template: |-
          {
              "messages": [
                {
                  "role": "system",
                  "content": "You are a helpful assistant who explains code to beginners."
                },
                {
                  "role": "user",
                  "content": "Explain what the following code does: {{code}}"
                }
              ]
          }
      - name: email-drafter
        template: |-
          {
              "messages": [
                {
                  "role": "system",
                  "content": "You write professional emails based on user input."
                },
                {
                  "role": "user",
                  "content": "Draft an email about {{topic}} to {{recipient}}."
                }
              ]
          }
      - name: product-describer
        template: |-
          {
              "messages": [
                {
                  "role": "system",
                  "content": "You write engaging product descriptions."
                },
                {
                  "role": "user",
                  "content": "Describe the product: {{product_name}, which has the following features: {{features}}."
                }
              ]
          }
      - name: qna
        template: |-
          {
              "messages": [
                {
                  "role": "system",
                  "content": "You answer questions clearly and accurately."
                },
                {
                  "role": "user",
                  "content": "Answer the following question: {{question}}"
                }
              ]
          }
' | deck gateway apply -

Validate configuration

Now, you can validate that the AI Prompt Template plugin configuration is correct by sending allowed and denied prompts.

Allowed prompts

Denied prompts

All requests that don’t use any of the configured templates will be automatically blocked by the plugin. For example:

 curl "$KONNECT_PROXY_URL/anything" \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "What is Pythagorean theorem?"
         }
       ]
     }'

You should see the following response:

this LLM route only supports templated requests
 curl "http://localhost:8000/anything" \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "What is Pythagorean theorem?"
         }
       ]
     }'

You should see the following response:

this LLM route only supports templated requests

Cleanup

If you created a new control plane and want to conserve your free trial credits or avoid unnecessary charges, delete the new control plane used in this tutorial.

curl -Ls https://get.konghq.com/quickstart | bash -s -- -d
Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!