AI RAG Injector Configuration - Plugin

name or plugin

string required

プラグイン名。この場合はai-rag-injector 。

Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

instance_name

string

プラグインのインスタンスを識別するための任意のカスタム名 (例: ai-rag-injector_my-service 。

インスタンス名はKong ManagerとKonnectに表示されるので、例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスにアクセスするためにも使用できます。

インスタンス名は、次のコンテキスト内で一意である必要があります。

Kong Gateway Enterpriseのワークスペース内
Konnectのコントロールプレーン（CP）またはコントロールプレーン（CP）グループ内
Kong Gateway (OSS)の全世界

service.name or service.id

string

プラグインが対象とするサービス名または ID。最上位の /plugins エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください /services/{serviceName|Id}/plugins を使用する場合は必要ありません。

route.name or route.id

string

プラグインがターゲットとするルート名または ID。最上位の /plugins エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください /routes/{routeName|Id}/plugins を使用する場合は必要ありません。

consumer.name or consumer.id

string

プラグインがターゲットとするコンシューマーの名前または ID。最上位の /plugins エンドポイント. からコンシューマーにプラグインを追加する場合は、これらのパラメーターのいずれかを設定してください /consumers/{consumerName|Id}/pluginsを使用する場合は必要ありません。

consumer_group.name or consumer_group.id

string

プラグインが対象とするコンシューマグループの名前または ID。設定されている場合、プラグインは指定されたグループが認証されているリクエストに対してのみアクティブになります/plugins エンドポイント. /consumer_groups/{consumerGroupName|Id}/pluginsを使用する場合は必要ありません。

enabled

boolean default: true

このプラグインが適用されるかどうか。

config

record required

stop_on_failure

boolean required default: false

Halt the LLM request process in case of a vectordb or embeddings service failure

inject_as_role

string required default: user Must be one of: system, assistant, user

inject_template

string required default:

fetch_chunks_count

number required default: 5

The maximum number of chunks to fetch from vectordb

vectordb_namespace

string required default: kong_rag_injector

The namespace of the vectordb to use for embeddings lookup

embeddings

record required
- auth
  
  record
  header_name
  
  string referenceable
  
  If AI model requires authentication via Authorization or API key header, specify its name here.
  
  header_value
  
  string referenceable encrypted
  
  Specify the full auth header value for ‘header_name’, for example ‘Bearer key’ or just ‘key’.
  
  param_name
  
  string referenceable
  
  If AI model requires authentication via query parameter, specify its name here.
  
  param_value
  
  string referenceable encrypted
  
  Specify the full parameter value for ‘param_name’.
  
  param_location
  
  string Must be one of: query, body
  
  Specify whether the ‘param_name’ and ‘param_value’ options go in a query string, or the POST form/JSON body.
  
  azure_use_managed_identity
  
  boolean default: false
  
  Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
  
  azure_client_id
  
  string referenceable
  
  If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client ID.
  
  azure_client_secret
  
  string referenceable encrypted
  
  If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the client secret.
  
  azure_tenant_id
  
  string referenceable
  
  If azure_use_managed_identity is set to true, and you need to use a different user-assigned identity for this LLM instance, set the tenant ID.
  
  gcp_use_service_account
  
  boolean default: false
  
  Use service account auth for GCP-based providers and models.
  
  gcp_service_account_json
  
  string referenceable encrypted
  
  Set this field to the full JSON of the GCP service account to authenticate, if required. If null (and gcp_use_service_account is true), Kong will attempt to read from environment variable GCP_SERVICE_ACCOUNT.
  
  aws_access_key_id
  
  string referenceable encrypted
  
  Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_ACCESS_KEY_ID environment variable for this plugin instance.
  
  aws_secret_access_key
  
  string referenceable encrypted
  
  Set this if you are using an AWS provider (Bedrock) and you are authenticating using static IAM User credentials. Setting this will override the AWS_SECRET_ACCESS_KEY environment variable for this plugin instance.
  
  allow_override
  
  boolean default: false
  
  If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- model
  
  record required
  provider
  
  string required Must be one of: openai, mistral, huggingface, azure, bedrock, gemini
  
  AI provider format to use for embeddings API
  
  name
  
  string required
  
  Model name to execute.
  
  options
  
  record
  
  Key/value settings for the model
  
  upstream_url
  
  string
  
  upstream url for the embeddings
  
  azure
  
  record required
  
  instance
  
  string
  
  Instance name for Azure OpenAI hosted models.
  
  api_version
  
  string default: 2023-05-15
  
  ‘api-version’ for Azure OpenAI instances.
  
  deployment_id
  
  string
  
  Deployment ID for Azure OpenAI instances.
  
  bedrock
  
  record
  
  aws_region
  
  string
  
  If using AWS providers (Bedrock) you can override the AWS_REGION environment variable by setting this option.
  
  aws_assume_role_arn
  
  string
  
  If using AWS providers (Bedrock) you can assume a different role after authentication with the current IAM context is successful.
  
  aws_role_session_name
  
  string
  
  If using AWS providers (Bedrock), set the identifier of the assumed role session.
  
  aws_sts_endpoint_url
  
  string
  
  If using AWS providers (Bedrock), override the STS endpoint URL when assuming a different role.
  
  gemini
  
  record
  
  api_endpoint
  
  string
  
  If running Gemini on Vertex, specify the regional API endpoint (hostname only).
  
  project_id
  
  string
  
  If running Gemini on Vertex, specify the project ID.
  
  location_id
  
  string
  
  If running Gemini on Vertex, specify the location ID.
  
  huggingface
  
  record
  
  use_cache
  
  boolean
  
  Use the cache layer on the inference API
  
  wait_for_model
  
  boolean
  
  Wait for the model if it is not ready

vectordb

record required
- strategy
  
  string required Must be one of: redis, pgvector
  
  which vector database driver to use
- dimensions
  
  integer required
  
  the desired dimensionality for the vectors
- distance_metric
  
  string required Must be one of: cosine, euclidean
  
  the distance metric to use for vector searches
- redis
  
  record required
  host
  
  string default: 127.0.0.1
  
  A string representing a host name, such as example.com.
  
  port
  
  integer default: 6379 between: 0 65535
  
  An integer representing a port number between 0 and 65535, inclusive.
  
  connect_timeout
  
  integer default: 2000 between: 0 2147483646
  
  An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
  
  send_timeout
  
  integer default: 2000 between: 0 2147483646
  
  An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
  
  read_timeout
  
  integer default: 2000 between: 0 2147483646
  
  An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
  
  username
  
  string referenceable
  
  Username to use for Redis connections. If undefined, ACL authentication won’t be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.
  
  password
  
  string referenceable encrypted
  
  Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
  
  sentinel_username
  
  string referenceable
  
  Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won’t be performed. This requires Redis v6.2.0+.
  
  sentinel_password
  
  string referenceable encrypted
  
  Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
  
  database
  
  integer default: 0
  
  Database to use for the Redis connection when using the redis strategy
  
  keepalive_pool_size
  
  integer default: 256 between: 1 2147483646
  
  The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn’t specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.
  
  keepalive_backlog
  
  integer between: 0 2147483646
  
  Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
  
  sentinel_master
  
  string
  
  Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
  
  sentinel_role
  
  string Must be one of: master, slave, any
  
  Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel.
  
  sentinel_nodes
  
  array of type record len_min: 1
  
  Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
  
  host
  
  string required default: 127.0.0.1
  
  A string representing a host name, such as example.com.
  
  port
  
  integer default: 6379 between: 0 65535
  
  An integer representing a port number between 0 and 65535, inclusive.
  
  cluster_nodes
  
  array of type record len_min: 1
  
  Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
  
  ip
  
  string required default: 127.0.0.1
  
  A string representing a host name, such as example.com.
  
  port
  
  integer default: 6379 between: 0 65535
  
  An integer representing a port number between 0 and 65535, inclusive.
  
  ssl
  
  boolean default: false
  
  If set to true, uses SSL to connect to Redis.
  
  ssl_verify
  
  boolean default: false
  
  If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
  
  server_name
  
  string
  
  A string representing an SNI (server name indication) value for TLS.
  
  cluster_max_redirections
  
  integer default: 5
  
  Maximum retry attempts for redirection.
  
  connection_is_proxied
  
  boolean default: false
  
  If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
- pgvector
  
  record required
  host
  
  string default: 127.0.0.1
  
  the host of the pgvector database
  
  port
  
  integer default: 5432
  
  the port of the pgvector database
  
  user
  
  string referenceable default: postgres
  
  the user of the pgvector database
  
  password
  
  string referenceable encrypted
  
  the password of the pgvector database
  
  database
  
  string default: kong-pgvector
  
  the database of the pgvector database
  
  timeout
  
  number default: 5000
  
  the timeout of the pgvector database
  
  ssl
  
  boolean default: false
  
  whether to use ssl for the pgvector database
  
  ssl_required
  
  boolean default: false
  
  whether ssl is required for the pgvector database
  
  ssl_verify
  
  boolean default: false
  
  whether to verify ssl for the pgvector database
  
  ssl_version
  
  string default: tlsv1_2 Must be one of: tlsv1_2, tlsv1_3, any
  
  the ssl version to use for the pgvector database
  
  ssl_cert
  
  string
  
  the path of ssl cert to use for the pgvector database
  
  ssl_cert_key
  
  string
  
  the path of ssl cert key to use for the pgvector database

構成

互換性のあるプロトコル

パラメータ

name or plugin

instance_name

service.name or service.id

route.name or route.id

consumer.name or consumer.id

consumer_group.name or consumer_group.id

enabled

config

stop_on_failure

inject_as_role

inject_template

fetch_chunks_count

vectordb_namespace

embeddings

auth

header_name

header_value

param_name

param_value

param_location

azure_use_managed_identity

azure_client_id

azure_client_secret

azure_tenant_id

gcp_use_service_account

gcp_service_account_json

aws_access_key_id

aws_secret_access_key

allow_override

model

provider

name

options

upstream_url

azure

instance

api_version

deployment_id

bedrock

aws_region

aws_assume_role_arn

aws_role_session_name

aws_sts_endpoint_url

gemini

api_endpoint

project_id

location_id

huggingface

use_cache

wait_for_model

vectordb

strategy

dimensions

distance_metric

redis

host

port

connect_timeout

send_timeout

read_timeout

username

password

sentinel_username

sentinel_password

database

keepalive_pool_size

keepalive_backlog

sentinel_master

sentinel_role

sentinel_nodes

host

port

cluster_nodes

ip

port

ssl

ssl_verify