---
title: "AIGatewayModelVectorDBConfig"
url: "https://nov18-dev.movespot.fyi/apis/konnect-ai-gateway-dev-0/versions/eaabd2fa-a9d5-44cc-b086-e210c9c21bf3/schemas/AIGatewayModelVectorDBConfig"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-ai-gateway-dev-0/versions/eaabd2fa-a9d5-44cc-b086-e210c9c21bf3.md

# AIGatewayModelVectorDBConfig

Configuration for the vector database used by the model.

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect AI Gateway
  version: 0.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    AIGatewayModelVectorDBConfigPgVector:
      type: object
      properties:
        strategy:
          type: string
          enum:
            - pgvector
        dimensions:
          description: the desired dimensionality for the vectors
          type: integer
        distance_metric:
          description: the distance metric to use for vector searches
          type: string
          enum:
            - cosine
            - euclidean
        threshold:
          description: the default similarity threshold for accepting semantic search
            results (float). Higher threshold means more results are considered
            similar.
          type: number
        database:
          description: the database of the pgvector database
          type: string
          default: kong-pgvector
        host:
          description: the host of the pgvector database
          type: string
          default: 127.0.0.1
        password:
          description: |-
            the password of the pgvector database 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). 
            This field is [encrypted](/gateway/keyring/).
          type: string
          writeOnly: true
          x-encrypted: true
          x-referenceable: true
        port:
          description: the port of the pgvector database
          type: integer
          default: 5432
        ssl:
          type: object
          additionalProperties: false
          properties:
            enabled:
              description: whether to use ssl for the pgvector database
              type: boolean
              default: false
            cert:
              description: the path of ssl cert to use for the pgvector database
              type: string
            cert_key:
              description: the path of ssl cert key to use for the pgvector database
              type: string
            required:
              description: whether ssl is required for the pgvector database
              type: boolean
              default: false
            verify:
              description: whether to verify ssl for the pgvector database
              type: boolean
              default: true
            version:
              description: the ssl version to use for the pgvector database
              type: string
              default: tlsv1_2
              enum:
                - any
                - tlsv1_2
                - tlsv1_3
        timeout:
          description: the timeout of the pgvector database
          type: number
          default: 5000
        user:
          description: |-
            the user of the pgvector database 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).
          type: string
          default: postgres
          x-referenceable: true
      additionalProperties: false
      required:
        - strategy
        - dimensions
        - distance_metric
    AIGatewayModelVectorDBConfigRedis:
      description: Config for connecting to a Cloud Provider's Redis instance.
      type: object
      properties:
        strategy:
          type: string
          enum:
            - redis
        dimensions:
          description: the desired dimensionality for the vectors
          type: integer
        distance_metric:
          description: the distance metric to use for vector searches
          type: string
          enum:
            - cosine
            - euclidean
        threshold:
          description: the default similarity threshold for accepting semantic search
            results (float). Higher threshold means more results are considered
            similar.
          type: number
        cloud_authentication:
          description: Auth related config for connecting to a Cloud Provider's Redis
            instance.
          discriminator:
            propertyName: type
            mapping:
              aws: "#/components/schemas/AIGatewayRedisAWSAuthentication"
              azure: "#/components/schemas/AIGatewayRedisAzureAuthentication"
              gcp: "#/components/schemas/AIGatewayRedisGCPAuthentication"
          oneOf:
            - $ref: "#/components/schemas/AIGatewayRedisAWSAuthentication"
            - $ref: "#/components/schemas/AIGatewayRedisAzureAuthentication"
            - $ref: "#/components/schemas/AIGatewayRedisGCPAuthentication"
        cluster:
          description: Cluster configuration for the Redis connection.
          type: object
          additionalProperties: false
          properties:
            max_redirections:
              description: Maximum retry attempts for redirection.
              type: integer
              default: 5
            nodes:
              description: 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.
              type: array
              items:
                type: object
                properties:
                  ip:
                    description: A string representing a host name, such as example.com.
                    type: string
                    default: 127.0.0.1
                  port:
                    description: An integer representing a port number between 0 and 65535,
                      inclusive.
                    type: integer
                    default: 6379
                    maximum: 65535
                    minimum: 0
              minItems: 1
        connect_timeout:
          description: An integer representing a timeout in milliseconds. Must be between
            0 and 2^31-2.
          type: integer
          default: 2000
          maximum: 2147483646
          minimum: 0
        connection_is_proxied:
          description: If the connection to Redis is proxied (e.g. Envoy), set it `true`.
            Set the `host` and `port` to point to the proxy address.
          type: boolean
          default: false
        database:
          description: Database to use for the Redis connection when using the `redis`
            strategy
          type: integer
          default: 0
        host:
          description: |-
            A string representing a host name, such as example.com. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).
          type: string
          default: 127.0.0.1
          x-referenceable: true
        keepalive:
          description: Keepalive configuration for the Redis connection.
          type: object
          additionalProperties: false
          properties:
            backlog:
              description: 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 `pool_size`. If latency is high or
                throughput is low, try increasing this value. Empirically, this
                value is larger than `pool_size`.
              type: integer
              maximum: 2147483646
              minimum: 0
            pool_size:
              description: The size limit for every cosocket connection pool associated with
                every remote server, per worker process. If neither `pool_size`
                nor `backlog` is specified, no pool is created. If `pool_size`
                isn't specified but `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.
              type: integer
              default: 256
              maximum: 2147483646
              minimum: 1
        password:
          description: |-
            Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). 
            This field is [encrypted](/gateway/keyring/).
          type: string
          x-encrypted: true
          x-referenceable: true
        port:
          description: |-
            An integer representing a port number between 0 and 65535, inclusive. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).
          type: integer
          default: 6379
          maximum: 65535
          minimum: 0
          x-referenceable: true
        read_timeout:
          description: An integer representing a timeout in milliseconds. Must be between
            0 and 2^31-2.
          type: integer
          default: 2000
          maximum: 2147483646
          minimum: 0
        send_timeout:
          description: An integer representing a timeout in milliseconds. Must be between
            0 and 2^31-2.
          type: integer
          default: 2000
          maximum: 2147483646
          minimum: 0
        sentinel:
          description: Configuration for Redis Sentinel.
          type: object
          additionalProperties: false
          properties:
            master:
              description: Sentinel master to use for Redis connections. Defining this value
                implies using Redis Sentinel.
              type: string
            nodes:
              description: 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.
              type: array
              items:
                type: object
                properties:
                  host:
                    description: A string representing a host name, such as example.com.
                    type: string
                    default: 127.0.0.1
                  port:
                    description: An integer representing a port number between 0 and 65535,
                      inclusive.
                    type: integer
                    default: 6379
                    maximum: 65535
                    minimum: 0
              minItems: 1
            password:
              description: |-
                Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels. 
                This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). 
                This field is [encrypted](/gateway/keyring/).
              type: string
              x-encrypted: true
              x-referenceable: true
            role:
              description: Sentinel role to use for Redis connections when the `redis`
                strategy is defined. Defining this value implies using Redis
                Sentinel.
              type: string
              enum:
                - any
                - master
                - slave
            username:
              description: |-
                Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+. 
                This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).
              type: string
              x-referenceable: true
        server_name:
          description: |-
            A string representing an SNI (server name indication) value for TLS. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).
          type: string
          x-referenceable: true
        ssl:
          description: If set to true, uses SSL to connect to Redis.
          type: boolean
          default: false
        ssl_verify:
          description: 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.
          type: boolean
          default: true
        username:
          description: |-
            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](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).
          type: string
          x-referenceable: true
      additionalProperties: false
      required:
        - strategy
        - dimensions
        - distance_metric
    AIGatewayRedisAWSAuthentication:
      description: AWS specific configs for connecting to a Cloud Provider's redis instance.
      type: object
      properties:
        type:
          type: string
          enum:
            - aws
        access_key_id:
          description: |-
            AWS Access Key ID to be used for authentication. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). 
            This field is [encrypted](/gateway/keyring/).
          type: string
          x-encrypted: true
          x-referenceable: true
        assume_role_arn:
          description: |-
            The ARN of the IAM role to assume for generating ElastiCache IAM authentication tokens. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). 
            This field is [encrypted](/gateway/keyring/).
          type: string
          x-encrypted: true
          x-referenceable: true
        cache_name:
          description: |-
            The name of the AWS Elasticache cluster. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).
          type: string
          x-referenceable: true
        is_serverless:
          description: This flag specifies whether the cluster is serverless.
          type: boolean
          default: true
        region:
          description: |-
            The region of the AWS ElastiCache cluster. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault).
          type: string
          x-referenceable: true
        role_session_name:
          description: |-
            The session name for the temporary credentials when assuming the IAM role. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). 
            This field is [encrypted](/gateway/keyring/).
          type: string
          x-encrypted: true
          x-referenceable: true
        secret_access_key:
          description: |-
            AWS Secret Access Key. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). 
            This field is [encrypted](/gateway/keyring/).
          type: string
          x-encrypted: true
          x-referenceable: true
      additionalProperties: false
      required:
        - type
    AIGatewayRedisAzureAuthentication:
      description: Azure specific configs for connecting to a Cloud Provider's redis
        instance.
      type: object
      properties:
        type:
          type: string
          enum:
            - azure
        client_id:
          description: |-
            Azure Client ID. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). 
            This field is [encrypted](/gateway/keyring/).
          type: string
          x-encrypted: true
          x-referenceable: true
        secret:
          description: |-
            Azure Client Secret. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). 
            This field is [encrypted](/gateway/keyring/).
          type: string
          x-encrypted: true
          x-referenceable: true
        tenant_id:
          description: |-
            Azure Tenant ID. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). 
            This field is [encrypted](/gateway/keyring/).
          type: string
          x-encrypted: true
          x-referenceable: true
      additionalProperties: false
      required:
        - type
    AIGatewayRedisGCPAuthentication:
      description: GCP specific configs for connecting to a Cloud Provider's redis instance.
      type: object
      properties:
        type:
          type: string
          enum:
            - gcp
        service_account_json:
          description: |-
            GCP Service Account JSON. 
            This field is [referenceable](/gateway/entities/vault/#how-do-i-reference-secrets-stored-in-a-vault). 
            This field is [encrypted](/gateway/keyring/).
          type: string
          x-encrypted: true
          x-referenceable: true
      additionalProperties: false
      required:
        - type
    AIGatewayModelVectorDBConfig:
      description: Configuration for the vector database used by the model.
      discriminator:
        propertyName: strategy
        mapping:
          pgvector: "#/components/schemas/AIGatewayModelVectorDBConfigPgVector"
          redis: "#/components/schemas/AIGatewayModelVectorDBConfigRedis"
      oneOf:
        - $ref: "#/components/schemas/AIGatewayModelVectorDBConfigPgVector"
        - $ref: "#/components/schemas/AIGatewayModelVectorDBConfigRedis"
```
