AIGatewayGeminiEmbeddingsModelConfig

object

Google Gemini-specific configuration for a model.

* Additional properties are NOT allowed.
namestringrequired

The name of the embeddings model.

upstream_urlstringrequired

The URL of the embeddings model.

typestringrequired

Allowed values:gemini

location_idstring

The Google Cloud location ID for the model endpoint.

api_endpointstring

The custom API endpoint for the Gemini model.

Example

AIGatewayHuggingfaceEmbeddingsModelConfig

object

Hugging Face-specific configuration for a model.

* Additional properties are NOT allowed.
namestringrequired

The name of the embeddings model.

upstream_urlstringrequired

The URL of the embeddings model.

typestringrequired

Allowed values:huggingface

use_cacheboolean

Whether to use the Hugging Face inference cache.

Default:false

wait_for_modelboolean

Whether to wait for the model to load if it is not ready.

Default:false

Example

AIGatewayModelVectorDBConfig

Configuration for the vector database used by the model.

One Of
strategystringrequired

Allowed values:pgvector

dimensionsintegerrequired

the desired dimensionality for the vectors

distance_metricstringrequired

the distance metric to use for vector searches

Allowed values:cosineeuclidean

thresholdnumber

the default similarity threshold for accepting semantic search results (float). Higher threshold means more results are considered similar.

databasestring

the database of the pgvector database

Default:kong-pgvector

hoststring

the host of the pgvector database

Default:127.0.0.1

passwordstring

the password of the pgvector database
This field is referenceable.
This field is encrypted.

portinteger

the port of the pgvector database

Default:5432

sslobject
* Additional properties are NOT allowed.
Show Child Parameters
timeoutnumber

the timeout of the pgvector database

Default:5000

userstring

the user of the pgvector database
This field is referenceable.

Default:postgres

Example

AIGatewayModelVectorDBConfigRedis

object

Config for connecting to a Cloud Provider’s Redis instance.

* Additional properties are NOT allowed.
strategystringrequired

Allowed values:redis

dimensionsintegerrequired

the desired dimensionality for the vectors

distance_metricstringrequired

the distance metric to use for vector searches

Allowed values:cosineeuclidean

thresholdnumber

the default similarity threshold for accepting semantic search results (float). Higher threshold means more results are considered similar.

cloud_authenticationOne Of

Auth related config for connecting to a Cloud Provider’s Redis instance.

AIGatewayRedisAWSAuthenticationobject

AWS specific configs for connecting to a Cloud Provider’s redis instance.

* Additional properties are NOT allowed.
Show Child Parameters
clusterobject

Cluster configuration for the Redis connection.

* Additional properties are NOT allowed.
Show Child Parameters
connect_timeoutinteger

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

Default:2000

>= 0<= 2147483646

connection_is_proxiedboolean

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.

Default:false

databaseinteger

Database to use for the Redis connection when using the redis strategy

Default:0

hoststring

A string representing a host name, such as example.com.
This field is referenceable.

Default:127.0.0.1

keepaliveobject

Keepalive configuration for the Redis connection.

* Additional properties are NOT allowed.
Show Child Parameters
passwordstring

Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
This field is referenceable.
This field is encrypted.

portinteger

An integer representing a port number between 0 and 65535, inclusive.
This field is referenceable.

Default:6379

>= 0<= 65535

read_timeoutinteger

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

Default:2000

>= 0<= 2147483646

send_timeoutinteger

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

Default:2000

>= 0<= 2147483646

sentinelobject

Configuration for Redis Sentinel.

* Additional properties are NOT allowed.
Show Child Parameters
server_namestring

A string representing an SNI (server name indication) value for TLS.
This field is referenceable.

sslboolean

If set to true, uses SSL to connect to Redis.

Default:false

ssl_verifyboolean

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.

Default:true

usernamestring

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.
This field is referenceable.

Example

AIGatewayModelVectorDBConfigPgVector

object
* Additional properties are NOT allowed.
strategystringrequired

Allowed values:pgvector

dimensionsintegerrequired

the desired dimensionality for the vectors

distance_metricstringrequired

the distance metric to use for vector searches

Allowed values:cosineeuclidean

thresholdnumber

the default similarity threshold for accepting semantic search results (float). Higher threshold means more results are considered similar.

databasestring

the database of the pgvector database

Default:kong-pgvector

hoststring

the host of the pgvector database

Default:127.0.0.1

passwordstring

the password of the pgvector database
This field is referenceable.
This field is encrypted.

portinteger

the port of the pgvector database

Default:5432

sslobject
* Additional properties are NOT allowed.
Show Child Parameters
timeoutnumber

the timeout of the pgvector database

Default:5000

userstring

the user of the pgvector database
This field is referenceable.

Default:postgres

Example