Home / How-to Guides
Edit
Report

Filter knowledge base queries with the AI RAG Injector plugin

Uses: Kong Gateway AI Gateway deck
Deployment Platform
Related Documentation
Gateway Documentation decK Documentation
Tags
#ai #openai
Related Resources
AI Gateway
AI RAG Injector
AI Proxy Advanced
Minimum Version
Kong Gateway - 3.13
TL;DR

Use metadata filters in your query requests to narrow results by tags, dates, sources, or other metadata fields. Filters apply within authorized collections and support exact matches, comparisons, and array operations.

Prerequisites

Kong Konnect

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.

Kong Gateway running

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   v1.43+

decK is a CLI tool for managing Kong Gateway declaratively with state files. To complete this tutorial, install decK version 1.43 or later.

This guide uses deck gateway apply, which directly applies entity configuration to your Gateway instance. We recommend upgrading your decK installation to take advantage of this tool.

You can check your current decK version with deck version.

Required entities

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.

OpenAI

This tutorial uses OpenAI:

  1. Create an OpenAI account.
  2. Get an API key.
  3. Create a decK variable with the API key:
export DECK_OPENAI_API_KEY="YOUR OPENAI API KEY"

export DECK_OPENAI_API_KEY="YOUR OPENAI API KEY"

Redis stack

To complete this tutorial, make sure you have the following:

  • A Redis Stack running and accessible from the environment where Kong is deployed.
  • Port 6379, or your custom Redis port is open and reachable from Kong.

  • Redis host set as an environment variable so the plugin can connect:

    export DECK_REDIS_HOST='YOUR-REDIS-HOST'

If you’re testing locally with Docker, use host.docker.internal as the host value.

Python

To complete this tutorial, you’ll need Python (version 3.7 or later) and pip installed on your machine. You can verify it by running:

python3
python3 -m pip --version

Configure the AI Proxy Advanced plugin

Configure the AI Proxy Advanced plugin to proxy prompt requests to your model provider:

echo '
_format_version: "3.0"
plugins:
  - name: ai-proxy-advanced
    config:
      targets:
      - route_type: llm/v1/chat
        auth:
          header_name: Authorization
          header_value: Bearer ${{ env "DECK_OPENAI_API_KEY" }}
        model:
          provider: openai
          name: gpt-4o
          options:
            max_tokens: 512
            temperature: 1.0
' | deck gateway apply -

Configure the AI RAG Injector plugin

Configure the AI RAG Injector plugin with a vector database for storing and retrieving knowledge base content:

echo '
_format_version: "3.0"
plugins:
  - name: ai-rag-injector
    id: b924e3e8-7893-4706-aacb-e75793a1d2e9
    config:
      embeddings:
        auth:
          header_name: Authorization
          header_value: Bearer ${{ env "DECK_OPENAI_API_KEY" }}
        model:
          provider: openai
          name: text-embedding-3-large
      vectordb:
        strategy: redis
        dimensions: 3072
        distance_metric: cosine
        redis:
          host: "${{ env "DECK_REDIS_HOST" }}"
          port: 6379
      inject_template: |
        Use the following context to answer the question. If the context doesnt contain relevant information, say so.
        Context:
        <CONTEXT>
        Question: <PROMPT>
      inject_as_role: system
' | deck gateway apply -

If your Redis instance runs in a separate Docker container from Kong, use host.docker.internal for vectordb.redis.host.

Ingest content with metadata

Ingest financial documents with metadata. Each chunk includes tags, dates, and sources that you can filter on. Use the Admin API to send ingestion requests with the metadata fields you’ll use for filtering later.

Create ingestion script

Create a Python script to ingest financial reports with metadata:

cat > ingest-filtering.py << 'EOF'
#!/usr/bin/env python3
import requests
import json

BASE_URL = "http://localhost:8001/ai-rag-injector/b924e3e8-7893-4706-aacb-e75793a1d2e9/ingest_chunk"

chunks = [
    {
        "content": "Q4 2024 Financial Results: Revenue increased 15% year-over-year to $2.3B. Operating margin improved to 24%, up from 21% in Q3. Key drivers included strong enterprise sales and improved operational efficiency.",
        "metadata": {
            "collection": "finance-reports",
            "source": "internal",
            "date": "2024-10-14T00:00:00Z",
            "report_type": "quarterly",
            "tags": ["finance", "quarterly", "q4", "2024", "current"]
        }
    },
    {
        "content": "Q3 2024 Financial Results: Revenue reached $2.0B with 12% year-over-year growth. Operating margin held steady at 21%. International markets contributed 35% of total revenue.",
        "metadata": {
            "collection": "finance-reports",
            "source": "internal",
            "date": "2024-07-15T00:00:00Z",
            "report_type": "quarterly",
            "tags": ["finance", "quarterly", "q3", "2024", "current"]
        }
    },
    {
        "content": "2024 Annual Report: Full-year revenue totaled $8.7B, representing 20% growth. The company expanded into five new markets and launched seven major product updates. Board approved $600M share buyback program.",
        "metadata": {
            "collection": "finance-reports",
            "source": "internal",
            "date": "2024-12-31T00:00:00Z",
            "report_type": "annual",
            "tags": ["finance", "annual", "2024", "current"]
        }
    },
    {
        "content": "2023 Annual Report: Full-year revenue totaled $7.8B, representing 18% growth. The company expanded into three new markets and launched five major product updates. Board approved $500M share buyback program.",
        "metadata": {
            "collection": "finance-reports",
            "source": "internal",
            "date": "2023-12-31T00:00:00Z",
            "report_type": "annual",
            "tags": ["finance", "annual", "2023"]
        }
    },
    {
        "content": "Morgan Stanley Analyst Report (Oct 2024): Maintains 'Overweight' rating with $145 price target. Cites strong execution, market expansion, and operating leverage as key positives. Recommends Buy.",
        "metadata": {
            "collection": "finance-reports",
            "source": "external",
            "date": "2024-10-20T00:00:00Z",
            "report_type": "analyst",
            "tags": ["analyst", "external", "2024", "recommendation"]
        }
    },
    {
        "content": "Goldman Sachs Sector Analysis (Sep 2024): Software sector shows resilient growth despite macro headwinds. Enterprise software spending expected to grow 12-15% in 2025. Cloud migration remains primary driver.",
        "metadata": {
            "collection": "finance-reports",
            "source": "external",
            "date": "2024-09-15T00:00:00Z",
            "report_type": "analyst",
            "tags": ["analyst", "external", "sector", "2024"]
        }
    },
    {
        "content": "Historical Data Archive: Q2 2022 revenue was $1.5B with 8% growth. This data is retained for historical analysis but may not reflect current business conditions or reporting standards.",
        "metadata": {
            "collection": "finance-reports",
            "source": "archive",
            "date": "2022-06-15T00:00:00Z",
            "report_type": "quarterly",
            "tags": ["finance", "quarterly", "q2", "2022", "archive"]
        }
    }
]

def ingest_chunks():
    headers = {"Content-Type": "application/json"}

    for i, chunk in enumerate(chunks, 1):
        try:
            response = requests.post(BASE_URL, json=chunk, headers=headers)
            response.raise_for_status()
            print(f"[{i}/{len(chunks)}] Ingested: {chunk['content'][:50]}...")
            print(response.json())
        except requests.exceptions.RequestException as e:
            print(f"[{i}/{len(chunks)}] Failed: {e}")
            if hasattr(e.response, 'text'):
                print(f"  Response: {e.response.text}")

if __name__ == "__main__":
    ingest_chunks()
EOF

Run the script to ingest all chunks:

python3 ingest-filtering.py

The script outputs the ingestion status and metadata for each chunk:

[1/7] Ingested: Q4 2024 Financial Results: Revenue increased 15% y...
{'metadata': {'ingest_duration': 714, 'chunk_id': 'a525cb7f-14f9-4628-a80f-779b3ca6b627', 'collection': 'finance-reports', 'embeddings_tokens_count': 50}}
[2/7] Ingested: Q3 2024 Financial Results: Revenue reached $2.0B w...
{'metadata': {'ingest_duration': 503, 'chunk_id': '7ed88dd1-7f92-4809-ad2b-7a2e080c4a04', 'collection': 'finance-reports', 'embeddings_tokens_count': 42}}
[3/7] Ingested: 2024 Annual Report: Full-year revenue totaled $8.7...
{'metadata': {'ingest_duration': 582, 'chunk_id': 'dc62bd16-49b1-4914-aa6c-3980fe775e85', 'collection': 'finance-reports', 'embeddings_tokens_count': 45}}
[4/7] Ingested: 2023 Annual Report: Full-year revenue totaled $7.8...
{'metadata': {'ingest_duration': 608, 'chunk_id': '1484e52c-fd17-4832-9f66-8e39be901a17', 'collection': 'finance-reports', 'embeddings_tokens_count': 45}}
[5/7] Ingested: Morgan Stanley Analyst Report (Oct 2024): Maintain...
{'metadata': {'ingest_duration': 347, 'chunk_id': 'dddf62f3-fb7f-4bbd-8d01-410f4915a18a', 'collection': 'finance-reports', 'embeddings_tokens_count': 43}}
[6/7] Ingested: Goldman Sachs Sector Analysis (Sep 2024): Software...
{'metadata': {'ingest_duration': 365, 'chunk_id': 'd3def3c0-18a4-48de-b4b2-4f9afbe982ad', 'collection': 'finance-reports', 'embeddings_tokens_count': 44}}
[7/7] Ingested: Historical Data Archive: Q2 2022 revenue was $1.5B...
{'metadata': {'ingest_duration': 598, 'chunk_id': '84258915-7061-46c5-9c11-7cb1b4cf5a19', 'collection': 'finance-reports', 'embeddings_tokens_count': 41}}

Validate metadata filtering

Send queries with different filter combinations to demonstrate how metadata filtering refines results.

Filter by date range

Query for recent reports (2024 only). This filter excludes older historical data and the results should include Q3 2024, Q4 2024, and 2024 annual report data, but exclude 2022 and 2023 data.

curl "$KONNECT_PROXY_URL/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "What were our financial results?"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "andAll": [
             {
               "greaterThanOrEquals": {
                 "key": "date",
                 "value": "2024-01-01"
               }
             }
           ]
         }
       }
     }'

You should see the following response:

The context provides financial results for Q3 and Q4 2024, as well as the annual results for 2024:\n\n- **Q3 2024:** Revenue was $2.0 billion with 12% year-over-year growth. Operating margin was 21%. International markets contributed 35% of total revenue.\n\n- **Q4 2024:** Revenue increased 15% year-over-year to $2.3 billion. Operating margin improved to 24%. Key drivers were strong enterprise sales and improved operational efficiency.\n\n- **2024 Annual Report:** Full-year revenue totaled $8.7 billion, representing 20% growth. The company expanded into five new markets and launched seven major product updates. The board approved a $600 million share buyback program.


curl "http://localhost:8000/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "What were our financial results?"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "andAll": [
             {
               "greaterThanOrEquals": {
                 "key": "date",
                 "value": "2024-01-01"
               }
             }
           ]
         }
       }
     }'

You should see the following response:

The context provides financial results for Q3 and Q4 2024, as well as the annual results for 2024:\n\n- **Q3 2024:** Revenue was $2.0 billion with 12% year-over-year growth. Operating margin was 21%. International markets contributed 35% of total revenue.\n\n- **Q4 2024:** Revenue increased 15% year-over-year to $2.3 billion. Operating margin improved to 24%. Key drivers were strong enterprise sales and improved operational efficiency.\n\n- **2024 Annual Report:** Full-year revenue totaled $8.7 billion, representing 20% growth. The company expanded into five new markets and launched seven major product updates. The board approved a $600 million share buyback program.

Filter by source

Query for internal reports only, excluding external analyst reports. The results should include internal quarterly and annual reports, but exclude analyst reports from Morgan Stanley and Goldman Sachs

curl "$KONNECT_PROXY_URL/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Summarize our financial performance"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "equals": {
             "key": "source",
             "value": "internal"
           }
         }
       }
     }'

You should see the following response:

Based on the provided context, our financial performance shows solid growth across the board. In Q4 2024, revenue increased by 15% year-over-year to $2.3 billion, with an improved operating margin of 24%. The key drivers for this performance included strong enterprise sales and improved operational efficiency. For the full year of 2024, revenue totaled $8.7 billion, indicating a 20% growth. The company expanded into five new markets and launched seven major product updates. Additionally, the board approved a $600 million share buyback program.\n\nCompared to 2023, where the full-year revenue was $7.8 billion with 18% growth, the company showed continued strong performance and strategic expansion efforts in 2024.


curl "http://localhost:8000/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Summarize our financial performance"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "equals": {
             "key": "source",
             "value": "internal"
           }
         }
       }
     }'

You should see the following response:

Based on the provided context, our financial performance shows solid growth across the board. In Q4 2024, revenue increased by 15% year-over-year to $2.3 billion, with an improved operating margin of 24%. The key drivers for this performance included strong enterprise sales and improved operational efficiency. For the full year of 2024, revenue totaled $8.7 billion, indicating a 20% growth. The company expanded into five new markets and launched seven major product updates. Additionally, the board approved a $600 million share buyback program.\n\nCompared to 2023, where the full-year revenue was $7.8 billion with 18% growth, the company showed continued strong performance and strategic expansion efforts in 2024.

Filter by report type

Query for quarterly reports only. The results should include Q3 and Q4 2024 quarterly reports, but exclude annual reports and analyst reports.

curl "$KONNECT_PROXY_URL/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Show quarterly performance trends"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "equals": {
             "key": "report_type",
             "value": "quarterly"
           }
         }
       }
     }'

You should see the following response:

The provided context contains data on quarterly and annual financial performance for the years 2023 and 2024, but it does not provide a detailed breakdown of quarterly performance trends for 2023. However, it does give insights into the quarterly performance of 2024:\n\n1. **Q3 2024:**\n   - Revenue: $2.0B\n   - Year-over-year growth: 12%\n   - Operating margin: 21%\n   - International markets contributed 35% of total revenue.\n\n2. **Q4 2024:**\n   - Revenue: $2.3B\n   - Year-over-year growth: 15%\n   - Operating margin improved to 24% (up from 21% in Q3).\n\nThe trends observed indicate a growth in revenue and operating margin in Q4 2024 compared to Q3 2024. There's a notable increase in both revenue and operating efficiency, primarily driven by strong enterprise sales and improved operational efficiency. For a comprehensive quarterly trend analysis, more data points from other quarters would be necessary, which are not provided in the current context.


curl "http://localhost:8000/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Show quarterly performance trends"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "equals": {
             "key": "report_type",
             "value": "quarterly"
           }
         }
       }
     }'

You should see the following response:

The provided context contains data on quarterly and annual financial performance for the years 2023 and 2024, but it does not provide a detailed breakdown of quarterly performance trends for 2023. However, it does give insights into the quarterly performance of 2024:\n\n1. **Q3 2024:**\n   - Revenue: $2.0B\n   - Year-over-year growth: 12%\n   - Operating margin: 21%\n   - International markets contributed 35% of total revenue.\n\n2. **Q4 2024:**\n   - Revenue: $2.3B\n   - Year-over-year growth: 15%\n   - Operating margin improved to 24% (up from 21% in Q3).\n\nThe trends observed indicate a growth in revenue and operating margin in Q4 2024 compared to Q3 2024. There's a notable increase in both revenue and operating efficiency, primarily driven by strong enterprise sales and improved operational efficiency. For a comprehensive quarterly trend analysis, more data points from other quarters would be necessary, which are not provided in the current context.

Filter by tags

Query for current (non-archived) data only using tag filtering. The results should include 2024 quarterly reports and annual report, but exclude 2022 archived data:

curl "$KONNECT_PROXY_URL/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "What are the latest financial metrics?"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "in": {
             "key": "tags",
             "value": [
               "current"
             ]
           }
         }
       }
     }'

You should see the following response:

The latest financial metrics provided in the context are from Q4 2024, where the revenue increased by 15% year-over-year to reach $2.3 billion. The operating margin improved to 24%. For the full year of 2024, the revenue totaled $8.7 billion, representing a 20% growth."


curl "http://localhost:8000/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "What are the latest financial metrics?"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "in": {
             "key": "tags",
             "value": [
               "current"
             ]
           }
         }
       }
     }'

You should see the following response:

The latest financial metrics provided in the context are from Q4 2024, where the revenue increased by 15% year-over-year to reach $2.3 billion. The operating margin improved to 24%. For the full year of 2024, the revenue totaled $8.7 billion, representing a 20% growth."

Combine multiple filters

Query for internal quarterly reports from 2024. The results should include only Q3 and Q4 2024 internal quarterly reports. Annual reports, analyst reports, and 2022/2023 data should be excluded in the response:

curl "$KONNECT_PROXY_URL/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Compare our quarterly results for 2024"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "andAll": [
             {
               "equals": {
                 "key": "source",
                 "value": "internal"
               }
             },
             {
               "equals": {
                 "key": "report_type",
                 "value": "quarterly"
               }
             },
             {
               "greaterThanOrEquals": {
                 "key": "date",
                 "value": "2024-01-01"
               }
             }
           ]
         }
       }
     }'

You should see the following response:

The context provided contains the necessary information to compare the quarterly results for 2024, specifically for Q3 and Q4:\n\n- **Q3 2024:**\n  - Revenue: $2.0 billion\n  - Year-over-year growth: 12%\n  - Operating margin: 21%\n  - International markets contributed 35% of total revenue.\n\n- **Q4 2024:**\n  - Revenue: $2.3 billion\n  - Year-over-year growth: 15%\n  - Operating margin: 24%\n  - Key drivers for this quarter included strong enterprise sales and improved operational efficiency.\n\nIn summary, from Q3 to Q4 2024, revenue increased from $2.0 billion to $2.3 billion, indicating a continued upward trend in growth with 15% year-over-year in Q4, compared to 12% in Q3. The operating margin improved as well, from 21% in Q3 to 24% in Q4, mainly due to strong enterprise sales and better operational efficiency in the fourth quarter.


curl "http://localhost:8000/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Compare our quarterly results for 2024"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "andAll": [
             {
               "equals": {
                 "key": "source",
                 "value": "internal"
               }
             },
             {
               "equals": {
                 "key": "report_type",
                 "value": "quarterly"
               }
             },
             {
               "greaterThanOrEquals": {
                 "key": "date",
                 "value": "2024-01-01"
               }
             }
           ]
         }
       }
     }'

You should see the following response:

The context provided contains the necessary information to compare the quarterly results for 2024, specifically for Q3 and Q4:\n\n- **Q3 2024:**\n  - Revenue: $2.0 billion\n  - Year-over-year growth: 12%\n  - Operating margin: 21%\n  - International markets contributed 35% of total revenue.\n\n- **Q4 2024:**\n  - Revenue: $2.3 billion\n  - Year-over-year growth: 15%\n  - Operating margin: 24%\n  - Key drivers for this quarter included strong enterprise sales and improved operational efficiency.\n\nIn summary, from Q3 to Q4 2024, revenue increased from $2.0 billion to $2.3 billion, indicating a continued upward trend in growth with 15% year-over-year in Q4, compared to 12% in Q3. The operating margin improved as well, from 21% in Q3 to 24% in Q4, mainly due to strong enterprise sales and better operational efficiency in the fourth quarter.

Filter for external analyst perspectives

Query for external analyst reports only. The results should include only Morgan Stanley and Goldman Sachs analyst reports, excluding all internal company reports:

curl "$KONNECT_PROXY_URL/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "What do analysts say about our company?"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "andAll": [
             {
               "equals": {
                 "key": "source",
                 "value": "external"
               }
             },
             {
               "in": {
                 "key": "tags",
                 "value": [
                   "analyst",
                   "recommendation"
                 ]
               }
             }
           ]
         }
       }
     }'

You should see the following response:

The context provided does not contain information specific to your company. It includes a Morgan Stanley report maintaining an Overweight rating with a $145 price target for an unnamed company and a Goldman Sachs analysis of the software sector.


curl "http://localhost:8000/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "What do analysts say about our company?"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "andAll": [
             {
               "equals": {
                 "key": "source",
                 "value": "external"
               }
             },
             {
               "in": {
                 "key": "tags",
                 "value": [
                   "analyst",
                   "recommendation"
                 ]
               }
             }
           ]
         }
       }
     }'

You should see the following response:

The context provided does not contain information specific to your company. It includes a Morgan Stanley report maintaining an Overweight rating with a $145 price target for an unnamed company and a Goldman Sachs analysis of the software sector.

Validate filter modes

The AI RAG Injector plugin supports two filter modes that control how chunks with no metadata are handled.

Compatible mode

Use filter_mode: compatible to include chunks that match the filter OR have no metadata. This mode is useful when your knowledge base contains both tagged and untagged content:

curl "$KONNECT_PROXY_URL/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Show me quarterly reports"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "equals": {
             "key": "report_type",
             "value": "quarterly"
           }
         },
         "filter_mode": "compatible"
       }
     }'

You should see the following response:

The context provided does not contain specific quarterly reports, but it does include some quarterly financial results and key performance highlights:\n\n- Q2 2022: Revenue was $1.5 billion with 8% growth.\n- Q3 2024: Revenue was $2.0 billion with 12% year-over-year growth. The operating margin was steady at 21%, and international markets contributed 35% of total revenue.\n- Q4 2024: Revenue increased 15% year-over-year to $2.3 billion. The operating margin improved to 24%.\n\nIf you need detailed quarterly reports beyond what is summarized here, please check the company's official filings or financial statements.


curl "http://localhost:8000/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Show me quarterly reports"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "equals": {
             "key": "report_type",
             "value": "quarterly"
           }
         },
         "filter_mode": "compatible"
       }
     }'

You should see the following response:

The context provided does not contain specific quarterly reports, but it does include some quarterly financial results and key performance highlights:\n\n- Q2 2022: Revenue was $1.5 billion with 8% growth.\n- Q3 2024: Revenue was $2.0 billion with 12% year-over-year growth. The operating margin was steady at 21%, and international markets contributed 35% of total revenue.\n- Q4 2024: Revenue increased 15% year-over-year to $2.3 billion. The operating margin improved to 24%.\n\nIf you need detailed quarterly reports beyond what is summarized here, please check the company's official filings or financial statements.

Strict mode

Use filter_mode: strict to include only chunks that match the filter. This mode excludes chunks with no metadata:

curl "$KONNECT_PROXY_URL/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Show me quarterly reports"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "andAll": [
             {
               "in": {
                 "key": "tags",
                 "value": [
                   "quarterly"
                 ]
               }
             }
           ]
         },
         "filter_mode": "strict"
       }
     }'

You should see the following response:

The context provided includes quarterly financial data for two specific quarters:\n\n1. **Q3 2024 Financial Results**:\n   - Revenue: $2.0 billion\n   - Year-over-year growth: 12%\n   - Operating margin: 21%\n   - Contribution of international markets to total revenue: 35%\n\n2. **Q4 2024 Financial Results**:\n   - Revenue: $2.3 billion\n   - Year-over-year growth: 15%\n   - Operating margin: 24%\n   - Key growth drivers: Strong enterprise sales and improved operational efficiency\n\nThere is also a historical data point mentioned for Q2 2022, with revenue of $1.5 billion and 8% growth. However, this may not reflect current business conditions or standards. \n\nIf you have a specific question about these reports or require more detailed information, please feel free to ask!


curl "http://localhost:8000/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Show me quarterly reports"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "andAll": [
             {
               "in": {
                 "key": "tags",
                 "value": [
                   "quarterly"
                 ]
               }
             }
           ]
         },
         "filter_mode": "strict"
       }
     }'

You should see the following response:

The context provided includes quarterly financial data for two specific quarters:\n\n1. **Q3 2024 Financial Results**:\n   - Revenue: $2.0 billion\n   - Year-over-year growth: 12%\n   - Operating margin: 21%\n   - Contribution of international markets to total revenue: 35%\n\n2. **Q4 2024 Financial Results**:\n   - Revenue: $2.3 billion\n   - Year-over-year growth: 15%\n   - Operating margin: 24%\n   - Key growth drivers: Strong enterprise sales and improved operational efficiency\n\nThere is also a historical data point mentioned for Q2 2022, with revenue of $1.5 billion and 8% growth. However, this may not reflect current business conditions or standards. \n\nIf you have a specific question about these reports or require more detailed information, please feel free to ask!

Validate error handling

Control how the plugin handles filter parsing errors with the stop_on_filter_error parameter.

Fail on error

When stop_on_filter_error is true, the plugin returns an error if filter parsing fails:

curl "$KONNECT_PROXY_URL/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Show me reports"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "invalidOperator": {
             "key": "report_type",
             "value": "quarterly"
           }
         },
         "stop_on_filter_error": true
       }
     }'

You should see the following response:

Invalid metadata filter: filter must contain 'andAll' wrapper


curl "http://localhost:8000/anything" \
     --no-progress-meter --fail-with-body  \
     -H "Content-Type: application/json" \
     --json '{
       "messages": [
         {
           "role": "user",
           "content": "Show me reports"
         }
       ],
       "ai-rag-injector": {
         "filters": {
           "invalidOperator": {
             "key": "report_type",
             "value": "quarterly"
           }
         },
         "stop_on_filter_error": true
       }
     }'

You should see the following response:

Invalid metadata filter: filter must contain 'andAll' wrapper

Cleanup

Clean up Konnect environment

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.

Destroy the Kong Gateway container

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

Flush Redis database

Reset the vector store and remove all ingested data, flush the Redis database:

docker exec -it redis-stack redis-cli FLUSHALL
Something wrong?
Report an Issue | Edit this Page

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!
Contribute

Still need help

Ask in our Forum
Contact Support