AI Proxy

You are browsing unreleased documentation.

Looking for the plugin's configuration parameters? You can find them in the AI Proxy configuration reference doc.

The AI Proxy plugin lets you transform and proxy requests to a number of AI providers and models.

The plugin accepts requests in one of a few defined and standardised formats, translates them to the configured target format, and then transforms the response back into a standard format.

The following table describes which providers and requests the AI Proxy plugin supports:

How it works

The AI Proxy will mediate the following for you:

• Request and response formats appropriate for the configured provider and route_type
• The following service request coordinates (unless the model is self-hosted):
  • Protocol
  • Host name
  • Port
  • Path
  • HTTP method
• Authentication on behalf of the Kong API consumer
• Decorating the request with parameters from the config.options block, appropriate for the chosen provider
• Recording of usage statistics of the configured LLM provider and model into your selected Kong log plugin output
• Optionally, additionally recording all post-transformation request and response messages from users, to and from the configured LLM
• Fulfillment of requests to self-hosted models, based on select supported format transformations

Flattening all of the provider formats allows you to standardize the manipulation of the data before and after transmission. It also allows your to provide a choice of LLMs to the Kong consumers, using consistent request and response formats, regardless of the backend provider or model.

This plugin currently only supports REST-based full text responses.

Request and response formats

The plugin’s config.route_type should be set based on the target upstream endpoint and model, based on this capability matrix:

The following upstream URL patterns are used:

While only the Llama2 and Mistral models are classed as self-hosted, the target URL can be overridden for any of the supported providers. For example, a self-hosted or otherwise OpenAI-compatible endpoint can be called by setting the same config.model.options.upstream_url plugin option.

Input formats

Kong will mediate the request and response format based on the selected config.provider and config.route_type, as outlined in the table above.

The Kong AI Proxy accepts the following inputs formats, standardized across all providers; the config.route_type must be configured respective to the required request and response format examples:

{
    "messages": [
        {
            "role": "system",
            "content": "You are a scientist."
        },
        {
            "role": "user",
            "content": "What is the theory of relativity?"
        }
    ]
}

{
    "prompt": "You are a scientist. What is the theory of relativity?"
}

Response formats

Conversely, the response formats are also transformed to a standard format across all providers:

{
    "choices": [
        {
            "finish_reason": "stop",
            "index": 0,
            "message": {
                "content": "The theory of relativity is a...",
                "role": "assistant"
            }
        }
    ],
    "created": 1707769597,
    "id": "chatcmpl-ID",
    "model": "gpt-4-0613",
    "object": "chat.completion",
    "usage": {
        "completion_tokens": 5,
        "prompt_tokens": 26,
        "total_tokens": 31
    }
}

{
    "choices": [
        {
            "finish_reason": "stop",
            "index": 0,
            "text": "The theory of relativity is a..."
        }
    ],
    "created": 1707769597,
    "id": "cmpl-ID",
    "model": "gpt-3.5-turbo-instruct",
    "object": "text_completion",
    "usage": {
        "completion_tokens": 10,
        "prompt_tokens": 7,
        "total_tokens": 17
    }
}

The request and response formats are loosely based on OpenAI. See the sample OpenAPI specification for more detail on the supported formats.

Check out the AI Gateway quickstart to get an AI proxy up and running within minutes!

Get started with the AI Proxy plugin

• AI Gateway quickstart: Set up AI Proxy
• Configuration reference
• Basic configuration example
• Learn how to use the plugin with different providers:
  • OpenAI
  • Cohere
  • Azure
  • Anthropic
  • Mistral
  • Llama2
  • Gemini/Vertex
  • Amazon Bedrock

All AI Gateway plugins

• AI Proxy
• AI Proxy Advanced
• AI Request Transformer
• AI Response Transformer
• AI Semantic Cache
• AI Semantic Prompt Guard
• AI Rate Limiting Advanced
• AI Azure Content Safety
• AI Prompt Template
• AI Prompt Guard
• AI Prompt Decorator