Plugins

Get a AiSemanticCache plugin

Get a AiSemanticCache plugin

get/v2/control-planes/{controlPlaneId}/core-entities/plugins/{PluginId}#AiSemanticCache

Response

AiSemanticCache plugin

conditionstring nullable

An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.

created_atinteger nullable

Unix epoch when the resource was created.

enabledboolean nullable

Whether the plugin is applied.

idstring nullable

A string representing a UUID (universally unique identifier).

instance_namestring nullable

A unique string representing a UTF-8 encoded name.

name'ai-semantic-cache' required

The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.

tagsstring[] nullable

An optional set of strings associated with the Plugin for grouping and filtering.

updated_atinteger nullable

Unix epoch when the resource was last updated.

protocolsstring[]

A set of strings representing HTTP protocols.

Changes

Changed in 13 of the 52 revisions of this API.60971

  • 4a39c7f8550911See the full diff
    • the allOf[AiSemanticCachePluginConfig]/config/vectordb/redis/port response's property type/format changed from integer/ to string/ for status 200

      response-property-type-changed

    • the port response's property default value changed from 6379 to 6379 for the status 200

      response-property-default-value-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 62c54f1094bb21See the full diff
    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings became optional for the status 200

      response-property-became-optional

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb became optional for the status 200

      response-property-became-optional

    • the response property allOf[PluginBase]/partials/items/path became required for the status 200

      response-property-became-required

  • 7d6a643707d915See the full diff
    • added the new ollama enum value to the allOf[AiSemanticCachePluginConfig]/config/embeddings/model/provider response property for the response status 200

      response-property-enum-value-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/gcp_metadata_url to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/gcp_oauth_token_url to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock/batch_bucket_prefix to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock/batch_role_arn to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[PluginBase]/condition to the response with the 200 status

      response-optional-property-added

  • ad02b4e24eb2212See the full diff
    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/threshold became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/threshold became optional for the status 200

      response-property-became-optional

    • added the new anthropic enum value to the allOf[AiSemanticCachePluginConfig]/config/llm_format response property for the response status 200

      response-property-enum-value-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock/video_output_s3_uri to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/vectordb/redis/cloud_authentication to the response with the 200 status

      response-optional-property-added

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/azure became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/azure became optional for the status 200

      response-property-became-optional

    • the allOf[AiSemanticCachePluginConfig]/name response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 96118a9cd7f44440See the full diff
    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/aws_access_key_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/aws_secret_access_key became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/azure_client_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/azure_client_secret became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/azure_tenant_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/gcp_service_account_json became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/header_name became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/header_value became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/param_name became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/auth/param_value became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/azure/deployment_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/azure/instance became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock/aws_assume_role_arn became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock/aws_region became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock/aws_role_session_name became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock/aws_sts_endpoint_url became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock/performance_config_latency became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/gemini became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/gemini/api_endpoint became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/gemini/location_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/gemini/project_id became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/huggingface became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/huggingface/use_cache became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/huggingface/wait_for_model became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/upstream_url became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/pgvector became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/pgvector/password became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/pgvector/ssl_cert became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/pgvector/ssl_cert_key became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/redis became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/redis/cluster_nodes became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/redis/keepalive_backlog became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/redis/password became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/redis/sentinel_master became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/redis/sentinel_nodes became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/redis/sentinel_password became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/redis/sentinel_username became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/redis/server_name became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/redis/username became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[PluginBase]/partials/items/name became nullable for the status 200

      response-property-became-nullable

    • the response property allOf[PluginBase]/partials/items/path became nullable for the status 200

      response-property-became-nullable

    • the allow_override response's property default value false was added for the status 200

      response-property-default-value-added

    • the api_version response's property default value 2023-05-15 was added for the status 200

      response-property-default-value-added

    • the azure_use_managed_identity response's property default value false was added for the status 200

      response-property-default-value-added

    • the cache_control response's property default value false was added for the status 200

      response-property-default-value-added

    • the cache_ttl response's property default value 300 was added for the status 200

      response-property-default-value-added

    • the cluster_max_redirections response's property default value 5 was added for the status 200

      response-property-default-value-added

    • the connect_timeout response's property default value 2000 was added for the status 200

      response-property-default-value-added

    • the connection_is_proxied response's property default value false was added for the status 200

      response-property-default-value-added

    • the database response's property default value 0 was added for the status 200

      response-property-default-value-added

    • the database response's property default value kong-pgvector was added for the status 200

      response-property-default-value-added

    • the embeddings_normalize response's property default value false was added for the status 200

      response-property-default-value-added

    • the enabled response's property default value true was added for the status 200

      response-property-default-value-added

    • the exact_caching response's property default value false was added for the status 200

      response-property-default-value-added

    • the gcp_use_service_account response's property default value false was added for the status 200

      response-property-default-value-added

    • the host response's property default value 127.0.0.1 was added for the status 200

      response-property-default-value-added

    • the host response's property default value 127.0.0.1 was added for the status 200

      response-property-default-value-added

    • the host response's property default value 127.0.0.1 was added for the status 200

      response-property-default-value-added

    • the ignore_assistant_prompts response's property default value false was added for the status 200

      response-property-default-value-added

    • the ignore_system_prompts response's property default value false was added for the status 200

      response-property-default-value-added

    • the ignore_tool_prompts response's property default value false was added for the status 200

      response-property-default-value-added

    • the ip response's property default value 127.0.0.1 was added for the status 200

      response-property-default-value-added

    • the keepalive_pool_size response's property default value 256 was added for the status 200

      response-property-default-value-added

    • the llm_format response's property default value openai was added for the status 200

      response-property-default-value-added

    • the message_countback response's property default value 1 was added for the status 200

      response-property-default-value-added

    • the port response's property default value 5432 was added for the status 200

      response-property-default-value-added

    • the port response's property default value 6379 was added for the status 200

      response-property-default-value-added

    • the port response's property default value 6379 was added for the status 200

      response-property-default-value-added

    • the port response's property default value 6379 was added for the status 200

      response-property-default-value-added

    • the protocols response's property default value grpc grpcs http https was added for the status 200

      response-property-default-value-added

    • the read_timeout response's property default value 2000 was added for the status 200

      response-property-default-value-added

    • the send_timeout response's property default value 2000 was added for the status 200

      response-property-default-value-added

    • the ssl response's property default value false was added for the status 200

      response-property-default-value-added

    • the ssl response's property default value false was added for the status 200

      response-property-default-value-added

    • the ssl_required response's property default value false was added for the status 200

      response-property-default-value-added

    • the ssl_verify response's property default value false was added for the status 200

      response-property-default-value-added

    • the ssl_verify response's property default value false was added for the status 200

      response-property-default-value-added

    • the ssl_version response's property default value tlsv1_2 was added for the status 200

      response-property-default-value-added

    • the stop_on_failure response's property default value false was added for the status 200

      response-property-default-value-added

    • the timeout response's property default value 5000 was added for the status 200

      response-property-default-value-added

    • the user response's property default value postgres was added for the status 200

      response-property-default-value-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2c77aeaee5fb1212See the full diff
    • the response property allOf[PluginBase]/tags became nullable for the status 200

      response-property-became-nullable

    • added the new cohere enum value to the allOf[AiSemanticCachePluginConfig]/config/llm_format response property for the response status 200

      response-property-enum-value-added

    • added the new huggingface enum value to the allOf[AiSemanticCachePluginConfig]/config/llm_format response property for the response status 200

      response-property-enum-value-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock/embeddings_normalize to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock/performance_config_latency to the response with the 200 status

      response-optional-property-added

    • the response property allOf[AiSemanticCachePluginConfig]/config became required for the status 200

      response-property-became-required

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings became required for the status 200

      response-property-became-required

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model became required for the status 200

      response-property-became-required

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/name became required for the status 200

      response-property-became-required

    • the response property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/provider became required for the status 200

      response-property-became-required

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb became required for the status 200

      response-property-became-required

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/dimensions became required for the status 200

      response-property-became-required

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/distance_metric became required for the status 200

      response-property-became-required

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/strategy became required for the status 200

      response-property-became-required

    • the response property allOf[AiSemanticCachePluginConfig]/config/vectordb/threshold became required for the status 200

      response-property-became-required

    • the allOf[AiSemanticCachePluginConfig]/protocols response's property type/format changed from array/ to array/set for status 200

      response-property-type-changed

    • added the optional property allOf[PluginBase]/partials to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new azure enum value to the allOf[AiSemanticCachePluginConfig]/config/embeddings/model/provider response property for the response status 200

      response-property-enum-value-added

    • added the new bedrock enum value to the allOf[AiSemanticCachePluginConfig]/config/embeddings/model/provider response property for the response status 200

      response-property-enum-value-added

    • added the new gemini enum value to the allOf[AiSemanticCachePluginConfig]/config/embeddings/model/provider response property for the response status 200

      response-property-enum-value-added

    • added the new huggingface enum value to the allOf[AiSemanticCachePluginConfig]/config/embeddings/model/provider response property for the response status 200

      response-property-enum-value-added

    • added the new pgvector enum value to the allOf[AiSemanticCachePluginConfig]/config/vectordb/strategy response property for the response status 200

      response-property-enum-value-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/bedrock to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/gemini to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/huggingface to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/llm_format to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[AiSemanticCachePluginConfig]/config/vectordb/pgvector to the response with the 200 status

      response-optional-property-added

    • added the required property allOf[AiSemanticCachePluginConfig]/config/embeddings/model/options/azure to the response with the 200 status

      response-required-property-added