konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
konnect.getGatewayPluginAiProxyAdvanced
Explore with Pulumi AI
Using getGatewayPluginAiProxyAdvanced
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getGatewayPluginAiProxyAdvanced(args: GetGatewayPluginAiProxyAdvancedArgs, opts?: InvokeOptions): Promise<GetGatewayPluginAiProxyAdvancedResult>
function getGatewayPluginAiProxyAdvancedOutput(args: GetGatewayPluginAiProxyAdvancedOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginAiProxyAdvancedResult>
def get_gateway_plugin_ai_proxy_advanced(control_plane_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetGatewayPluginAiProxyAdvancedResult
def get_gateway_plugin_ai_proxy_advanced_output(control_plane_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginAiProxyAdvancedResult]
func LookupGatewayPluginAiProxyAdvanced(ctx *Context, args *LookupGatewayPluginAiProxyAdvancedArgs, opts ...InvokeOption) (*LookupGatewayPluginAiProxyAdvancedResult, error)
func LookupGatewayPluginAiProxyAdvancedOutput(ctx *Context, args *LookupGatewayPluginAiProxyAdvancedOutputArgs, opts ...InvokeOption) LookupGatewayPluginAiProxyAdvancedResultOutput
> Note: This function is named LookupGatewayPluginAiProxyAdvanced
in the Go SDK.
public static class GetGatewayPluginAiProxyAdvanced
{
public static Task<GetGatewayPluginAiProxyAdvancedResult> InvokeAsync(GetGatewayPluginAiProxyAdvancedArgs args, InvokeOptions? opts = null)
public static Output<GetGatewayPluginAiProxyAdvancedResult> Invoke(GetGatewayPluginAiProxyAdvancedInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGatewayPluginAiProxyAdvancedResult> getGatewayPluginAiProxyAdvanced(GetGatewayPluginAiProxyAdvancedArgs args, InvokeOptions options)
public static Output<GetGatewayPluginAiProxyAdvancedResult> getGatewayPluginAiProxyAdvanced(GetGatewayPluginAiProxyAdvancedArgs args, InvokeOptions options)
fn::invoke:
function: konnect:index/getGatewayPluginAiProxyAdvanced:getGatewayPluginAiProxyAdvanced
arguments:
# arguments dictionary
The following arguments are supported:
- Control
Plane Id This property is required. string
- Control
Plane Id This property is required. string
- control
Plane Id This property is required. String
- control
Plane Id This property is required. string
- control_
plane_ id This property is required. str
- control
Plane Id This property is required. String
getGatewayPluginAiProxyAdvanced Result
The following output properties are available:
- Config
Get
Gateway Plugin Ai Proxy Advanced Config - Consumer
Get
Gateway Plugin Ai Proxy Advanced Consumer - Consumer
Group GetGateway Plugin Ai Proxy Advanced Consumer Group - Control
Plane stringId - Created
At double - Enabled bool
- Id string
- Instance
Name string - Ordering
Get
Gateway Plugin Ai Proxy Advanced Ordering - Protocols List<string>
- Route
Get
Gateway Plugin Ai Proxy Advanced Route - Service
Get
Gateway Plugin Ai Proxy Advanced Service - List<string>
- Updated
At double
- Config
Get
Gateway Plugin Ai Proxy Advanced Config - Consumer
Get
Gateway Plugin Ai Proxy Advanced Consumer - Consumer
Group GetGateway Plugin Ai Proxy Advanced Consumer Group - Control
Plane stringId - Created
At float64 - Enabled bool
- Id string
- Instance
Name string - Ordering
Get
Gateway Plugin Ai Proxy Advanced Ordering - Protocols []string
- Route
Get
Gateway Plugin Ai Proxy Advanced Route - Service
Get
Gateway Plugin Ai Proxy Advanced Service - []string
- Updated
At float64
- config
Get
Gateway Plugin Ai Proxy Advanced Config - consumer
Get
Gateway Plugin Ai Proxy Advanced Consumer - consumer
Group GetGateway Plugin Ai Proxy Advanced Consumer Group - control
Plane StringId - created
At Double - enabled Boolean
- id String
- instance
Name String - ordering
Get
Gateway Plugin Ai Proxy Advanced Ordering - protocols List<String>
- route
Get
Gateway Plugin Ai Proxy Advanced Route - service
Get
Gateway Plugin Ai Proxy Advanced Service - List<String>
- updated
At Double
- config
Get
Gateway Plugin Ai Proxy Advanced Config - consumer
Get
Gateway Plugin Ai Proxy Advanced Consumer - consumer
Group GetGateway Plugin Ai Proxy Advanced Consumer Group - control
Plane stringId - created
At number - enabled boolean
- id string
- instance
Name string - ordering
Get
Gateway Plugin Ai Proxy Advanced Ordering - protocols string[]
- route
Get
Gateway Plugin Ai Proxy Advanced Route - service
Get
Gateway Plugin Ai Proxy Advanced Service - string[]
- updated
At number
- config
Get
Gateway Plugin Ai Proxy Advanced Config - consumer
Get
Gateway Plugin Ai Proxy Advanced Consumer - consumer_
group GetGateway Plugin Ai Proxy Advanced Consumer Group - control_
plane_ strid - created_
at float - enabled bool
- id str
- instance_
name str - ordering
Get
Gateway Plugin Ai Proxy Advanced Ordering - protocols Sequence[str]
- route
Get
Gateway Plugin Ai Proxy Advanced Route - service
Get
Gateway Plugin Ai Proxy Advanced Service - Sequence[str]
- updated_
at float
- config Property Map
- consumer Property Map
- consumer
Group Property Map - control
Plane StringId - created
At Number - enabled Boolean
- id String
- instance
Name String - ordering Property Map
- protocols List<String>
- route Property Map
- service Property Map
- List<String>
- updated
At Number
Supporting Types
GetGatewayPluginAiProxyAdvancedConfig
- Balancer
This property is required. GetGateway Plugin Ai Proxy Advanced Config Balancer - Embeddings
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings - Max
Request Body Size This property is required. double - max allowed body size allowed to be introspected
- Model
Name Header This property is required. bool - Display the model name selected in the X-Kong-LLM-Model response header
- Response
Streaming This property is required. string - Whether to 'optionally allow', 'deny', or 'always' (force) the streaming of answers via server sent events.
- Targets
This property is required. List<GetGateway Plugin Ai Proxy Advanced Config Target> - Vectordb
This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb
- Balancer
This property is required. GetGateway Plugin Ai Proxy Advanced Config Balancer - Embeddings
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings - Max
Request Body Size This property is required. float64 - max allowed body size allowed to be introspected
- Model
Name Header This property is required. bool - Display the model name selected in the X-Kong-LLM-Model response header
- Response
Streaming This property is required. string - Whether to 'optionally allow', 'deny', or 'always' (force) the streaming of answers via server sent events.
- Targets
This property is required. []GetGateway Plugin Ai Proxy Advanced Config Target - Vectordb
This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb
- balancer
This property is required. GetGateway Plugin Ai Proxy Advanced Config Balancer - embeddings
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings - max
Request Body Size This property is required. Double - max allowed body size allowed to be introspected
- model
Name Header This property is required. Boolean - Display the model name selected in the X-Kong-LLM-Model response header
- response
Streaming This property is required. String - Whether to 'optionally allow', 'deny', or 'always' (force) the streaming of answers via server sent events.
- targets
This property is required. List<GetGateway Plugin Ai Proxy Advanced Config Target> - vectordb
This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb
- balancer
This property is required. GetGateway Plugin Ai Proxy Advanced Config Balancer - embeddings
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings - max
Request Body Size This property is required. number - max allowed body size allowed to be introspected
- model
Name Header This property is required. boolean - Display the model name selected in the X-Kong-LLM-Model response header
- response
Streaming This property is required. string - Whether to 'optionally allow', 'deny', or 'always' (force) the streaming of answers via server sent events.
- targets
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target[] - vectordb
This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb
- balancer
This property is required. GetGateway Plugin Ai Proxy Advanced Config Balancer - embeddings
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings - max_
request_ body_ size This property is required. float - max allowed body size allowed to be introspected
- model_
name_ header This property is required. bool - Display the model name selected in the X-Kong-LLM-Model response header
- response_
streaming This property is required. str - Whether to 'optionally allow', 'deny', or 'always' (force) the streaming of answers via server sent events.
- targets
This property is required. Sequence[GetGateway Plugin Ai Proxy Advanced Config Target] - vectordb
This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb
- balancer
This property is required. Property Map - embeddings
This property is required. Property Map - max
Request Body Size This property is required. Number - max allowed body size allowed to be introspected
- model
Name Header This property is required. Boolean - Display the model name selected in the X-Kong-LLM-Model response header
- response
Streaming This property is required. String - Whether to 'optionally allow', 'deny', or 'always' (force) the streaming of answers via server sent events.
- targets
This property is required. List<Property Map> - vectordb
This property is required. Property Map
GetGatewayPluginAiProxyAdvancedConfigBalancer
- Algorithm
This property is required. string - Which load balancing algorithm to use.
- Connect
Timeout This property is required. double - Hash
On Header This property is required. string - The header to use for consistent-hashing.
- Latency
Strategy This property is required. string - What metrics to use for latency. Available values are:
tpot
(time-per-output-token) ande2e
. - Read
Timeout This property is required. double - Retries
This property is required. double - The number of retries to execute upon failure to proxy.
- Slots
This property is required. double - The number of slots in the load balancer algorithm.
- Tokens
Count Strategy This property is required. string - What tokens to use for usage calculation. Available values are:
total_tokens
prompt_tokens
, andcompletion_tokens
. - Write
Timeout This property is required. double
- Algorithm
This property is required. string - Which load balancing algorithm to use.
- Connect
Timeout This property is required. float64 - Hash
On Header This property is required. string - The header to use for consistent-hashing.
- Latency
Strategy This property is required. string - What metrics to use for latency. Available values are:
tpot
(time-per-output-token) ande2e
. - Read
Timeout This property is required. float64 - Retries
This property is required. float64 - The number of retries to execute upon failure to proxy.
- Slots
This property is required. float64 - The number of slots in the load balancer algorithm.
- Tokens
Count Strategy This property is required. string - What tokens to use for usage calculation. Available values are:
total_tokens
prompt_tokens
, andcompletion_tokens
. - Write
Timeout This property is required. float64
- algorithm
This property is required. String - Which load balancing algorithm to use.
- connect
Timeout This property is required. Double - hash
On Header This property is required. String - The header to use for consistent-hashing.
- latency
Strategy This property is required. String - What metrics to use for latency. Available values are:
tpot
(time-per-output-token) ande2e
. - read
Timeout This property is required. Double - retries
This property is required. Double - The number of retries to execute upon failure to proxy.
- slots
This property is required. Double - The number of slots in the load balancer algorithm.
- tokens
Count Strategy This property is required. String - What tokens to use for usage calculation. Available values are:
total_tokens
prompt_tokens
, andcompletion_tokens
. - write
Timeout This property is required. Double
- algorithm
This property is required. string - Which load balancing algorithm to use.
- connect
Timeout This property is required. number - hash
On Header This property is required. string - The header to use for consistent-hashing.
- latency
Strategy This property is required. string - What metrics to use for latency. Available values are:
tpot
(time-per-output-token) ande2e
. - read
Timeout This property is required. number - retries
This property is required. number - The number of retries to execute upon failure to proxy.
- slots
This property is required. number - The number of slots in the load balancer algorithm.
- tokens
Count Strategy This property is required. string - What tokens to use for usage calculation. Available values are:
total_tokens
prompt_tokens
, andcompletion_tokens
. - write
Timeout This property is required. number
- algorithm
This property is required. str - Which load balancing algorithm to use.
- connect_
timeout This property is required. float - hash_
on_ header This property is required. str - The header to use for consistent-hashing.
- latency_
strategy This property is required. str - What metrics to use for latency. Available values are:
tpot
(time-per-output-token) ande2e
. - read_
timeout This property is required. float - retries
This property is required. float - The number of retries to execute upon failure to proxy.
- slots
This property is required. float - The number of slots in the load balancer algorithm.
- tokens_
count_ strategy This property is required. str - What tokens to use for usage calculation. Available values are:
total_tokens
prompt_tokens
, andcompletion_tokens
. - write_
timeout This property is required. float
- algorithm
This property is required. String - Which load balancing algorithm to use.
- connect
Timeout This property is required. Number - hash
On Header This property is required. String - The header to use for consistent-hashing.
- latency
Strategy This property is required. String - What metrics to use for latency. Available values are:
tpot
(time-per-output-token) ande2e
. - read
Timeout This property is required. Number - retries
This property is required. Number - The number of retries to execute upon failure to proxy.
- slots
This property is required. Number - The number of slots in the load balancer algorithm.
- tokens
Count Strategy This property is required. String - What tokens to use for usage calculation. Available values are:
total_tokens
prompt_tokens
, andcompletion_tokens
. - write
Timeout This property is required. Number
GetGatewayPluginAiProxyAdvancedConfigEmbeddings
- Auth
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Auth - Model
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Model
- Auth
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Auth - Model
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Model
- auth
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Auth - model
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Model
- auth
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Auth - model
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Model
- auth
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Auth - model
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Model
- auth
This property is required. Property Map - model
This property is required. Property Map
GetGatewayPluginAiProxyAdvancedConfigEmbeddingsAuth
- Allow
Override This property is required. bool - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- Aws
Access Key Id This property is required. string - 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 This property is required. string - 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.
- Azure
Client Id This property is required. string - 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 This property is required. string - 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 This property is required. string - 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.
- Azure
Use Managed Identity This property is required. bool - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- Gcp
Service Account Json This property is required. string - 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
. - Gcp
Use Service Account This property is required. bool - Use service account auth for GCP-based providers and models.
- Header
Name This property is required. string - If AI model requires authentication via Authorization or API key header, specify its name here.
- Header
Value This property is required. string - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- Param
Location This property is required. string - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- Param
Name This property is required. string - If AI model requires authentication via query parameter, specify its name here.
- Param
Value This property is required. string - Specify the full parameter value for 'param_name'.
- Allow
Override This property is required. bool - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- Aws
Access Key Id This property is required. string - 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 This property is required. string - 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.
- Azure
Client Id This property is required. string - 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 This property is required. string - 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 This property is required. string - 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.
- Azure
Use Managed Identity This property is required. bool - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- Gcp
Service Account Json This property is required. string - 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
. - Gcp
Use Service Account This property is required. bool - Use service account auth for GCP-based providers and models.
- Header
Name This property is required. string - If AI model requires authentication via Authorization or API key header, specify its name here.
- Header
Value This property is required. string - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- Param
Location This property is required. string - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- Param
Name This property is required. string - If AI model requires authentication via query parameter, specify its name here.
- Param
Value This property is required. string - Specify the full parameter value for 'param_name'.
- allow
Override This property is required. Boolean - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- aws
Access Key Id This property is required. String - 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 This property is required. String - 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.
- azure
Client Id This property is required. String - 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 This property is required. String - 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 This property is required. String - 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.
- azure
Use Managed Identity This property is required. Boolean - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- gcp
Service Account Json This property is required. String - 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
. - gcp
Use Service Account This property is required. Boolean - Use service account auth for GCP-based providers and models.
- header
Name This property is required. String - If AI model requires authentication via Authorization or API key header, specify its name here.
- header
Value This property is required. String - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- param
Location This property is required. String - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- param
Name This property is required. String - If AI model requires authentication via query parameter, specify its name here.
- param
Value This property is required. String - Specify the full parameter value for 'param_name'.
- allow
Override This property is required. boolean - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- aws
Access Key Id This property is required. string - 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 This property is required. string - 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.
- azure
Client Id This property is required. string - 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 This property is required. string - 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 This property is required. string - 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.
- azure
Use Managed Identity This property is required. boolean - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- gcp
Service Account Json This property is required. string - 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
. - gcp
Use Service Account This property is required. boolean - Use service account auth for GCP-based providers and models.
- header
Name This property is required. string - If AI model requires authentication via Authorization or API key header, specify its name here.
- header
Value This property is required. string - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- param
Location This property is required. string - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- param
Name This property is required. string - If AI model requires authentication via query parameter, specify its name here.
- param
Value This property is required. string - Specify the full parameter value for 'param_name'.
- allow_
override This property is required. bool - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- aws_
access_ key_ id This property is required. str - 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 This property is required. str - 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.
- azure_
client_ id This property is required. str - 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 This property is required. str - 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 This property is required. str - 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.
- azure_
use_ managed_ identity This property is required. bool - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- gcp_
service_ account_ json This property is required. str - 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
. - gcp_
use_ service_ account This property is required. bool - Use service account auth for GCP-based providers and models.
- header_
name This property is required. str - If AI model requires authentication via Authorization or API key header, specify its name here.
- header_
value This property is required. str - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- param_
location This property is required. str - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- param_
name This property is required. str - If AI model requires authentication via query parameter, specify its name here.
- param_
value This property is required. str - Specify the full parameter value for 'param_name'.
- allow
Override This property is required. Boolean - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- aws
Access Key Id This property is required. String - 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 This property is required. String - 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.
- azure
Client Id This property is required. String - 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 This property is required. String - 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 This property is required. String - 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.
- azure
Use Managed Identity This property is required. Boolean - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- gcp
Service Account Json This property is required. String - 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
. - gcp
Use Service Account This property is required. Boolean - Use service account auth for GCP-based providers and models.
- header
Name This property is required. String - If AI model requires authentication via Authorization or API key header, specify its name here.
- header
Value This property is required. String - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- param
Location This property is required. String - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- param
Name This property is required. String - If AI model requires authentication via query parameter, specify its name here.
- param
Value This property is required. String - Specify the full parameter value for 'param_name'.
GetGatewayPluginAiProxyAdvancedConfigEmbeddingsModel
- Name
This property is required. string - Model name to execute.
- Options
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Model Options - Key/value settings for the model
- Provider
This property is required. string - AI provider format to use for embeddings API
- Name
This property is required. string - Model name to execute.
- Options
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Model Options - Key/value settings for the model
- Provider
This property is required. string - AI provider format to use for embeddings API
- name
This property is required. String - Model name to execute.
- options
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Model Options - Key/value settings for the model
- provider
This property is required. String - AI provider format to use for embeddings API
- name
This property is required. string - Model name to execute.
- options
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Model Options - Key/value settings for the model
- provider
This property is required. string - AI provider format to use for embeddings API
- name
This property is required. str - Model name to execute.
- options
This property is required. GetGateway Plugin Ai Proxy Advanced Config Embeddings Model Options - Key/value settings for the model
- provider
This property is required. str - AI provider format to use for embeddings API
- name
This property is required. String - Model name to execute.
- options
This property is required. Property Map - Key/value settings for the model
- provider
This property is required. String - AI provider format to use for embeddings API
GetGatewayPluginAiProxyAdvancedConfigEmbeddingsModelOptions
- Upstream
Url This property is required. string - upstream url for the embeddings
- Upstream
Url This property is required. string - upstream url for the embeddings
- upstream
Url This property is required. String - upstream url for the embeddings
- upstream
Url This property is required. string - upstream url for the embeddings
- upstream_
url This property is required. str - upstream url for the embeddings
- upstream
Url This property is required. String - upstream url for the embeddings
GetGatewayPluginAiProxyAdvancedConfigTarget
- Auth
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Auth - Description
This property is required. string - The semantic description of the target, required if using semantic load balancing.
- Logging
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Logging - Model
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model - Route
Type This property is required. string - The model's operation implementation, for this provider. Set to
preserve
to pass through without transformation. - Weight
This property is required. double - The weight this target gets within the upstream loadbalancer (1-65535).
- Auth
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Auth - Description
This property is required. string - The semantic description of the target, required if using semantic load balancing.
- Logging
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Logging - Model
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model - Route
Type This property is required. string - The model's operation implementation, for this provider. Set to
preserve
to pass through without transformation. - Weight
This property is required. float64 - The weight this target gets within the upstream loadbalancer (1-65535).
- auth
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Auth - description
This property is required. String - The semantic description of the target, required if using semantic load balancing.
- logging
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Logging - model
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model - route
Type This property is required. String - The model's operation implementation, for this provider. Set to
preserve
to pass through without transformation. - weight
This property is required. Double - The weight this target gets within the upstream loadbalancer (1-65535).
- auth
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Auth - description
This property is required. string - The semantic description of the target, required if using semantic load balancing.
- logging
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Logging - model
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model - route
Type This property is required. string - The model's operation implementation, for this provider. Set to
preserve
to pass through without transformation. - weight
This property is required. number - The weight this target gets within the upstream loadbalancer (1-65535).
- auth
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Auth - description
This property is required. str - The semantic description of the target, required if using semantic load balancing.
- logging
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Logging - model
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model - route_
type This property is required. str - The model's operation implementation, for this provider. Set to
preserve
to pass through without transformation. - weight
This property is required. float - The weight this target gets within the upstream loadbalancer (1-65535).
- auth
This property is required. Property Map - description
This property is required. String - The semantic description of the target, required if using semantic load balancing.
- logging
This property is required. Property Map - model
This property is required. Property Map - route
Type This property is required. String - The model's operation implementation, for this provider. Set to
preserve
to pass through without transformation. - weight
This property is required. Number - The weight this target gets within the upstream loadbalancer (1-65535).
GetGatewayPluginAiProxyAdvancedConfigTargetAuth
- Allow
Override This property is required. bool - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- Aws
Access Key Id This property is required. string - 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 This property is required. string - 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.
- Azure
Client Id This property is required. string - 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 This property is required. string - 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 This property is required. string - 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.
- Azure
Use Managed Identity This property is required. bool - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- Gcp
Service Account Json This property is required. string - 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
. - Gcp
Use Service Account This property is required. bool - Use service account auth for GCP-based providers and models.
- Header
Name This property is required. string - If AI model requires authentication via Authorization or API key header, specify its name here.
- Header
Value This property is required. string - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- Param
Location This property is required. string - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- Param
Name This property is required. string - If AI model requires authentication via query parameter, specify its name here.
- Param
Value This property is required. string - Specify the full parameter value for 'param_name'.
- Allow
Override This property is required. bool - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- Aws
Access Key Id This property is required. string - 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 This property is required. string - 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.
- Azure
Client Id This property is required. string - 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 This property is required. string - 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 This property is required. string - 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.
- Azure
Use Managed Identity This property is required. bool - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- Gcp
Service Account Json This property is required. string - 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
. - Gcp
Use Service Account This property is required. bool - Use service account auth for GCP-based providers and models.
- Header
Name This property is required. string - If AI model requires authentication via Authorization or API key header, specify its name here.
- Header
Value This property is required. string - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- Param
Location This property is required. string - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- Param
Name This property is required. string - If AI model requires authentication via query parameter, specify its name here.
- Param
Value This property is required. string - Specify the full parameter value for 'param_name'.
- allow
Override This property is required. Boolean - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- aws
Access Key Id This property is required. String - 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 This property is required. String - 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.
- azure
Client Id This property is required. String - 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 This property is required. String - 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 This property is required. String - 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.
- azure
Use Managed Identity This property is required. Boolean - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- gcp
Service Account Json This property is required. String - 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
. - gcp
Use Service Account This property is required. Boolean - Use service account auth for GCP-based providers and models.
- header
Name This property is required. String - If AI model requires authentication via Authorization or API key header, specify its name here.
- header
Value This property is required. String - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- param
Location This property is required. String - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- param
Name This property is required. String - If AI model requires authentication via query parameter, specify its name here.
- param
Value This property is required. String - Specify the full parameter value for 'param_name'.
- allow
Override This property is required. boolean - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- aws
Access Key Id This property is required. string - 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 This property is required. string - 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.
- azure
Client Id This property is required. string - 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 This property is required. string - 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 This property is required. string - 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.
- azure
Use Managed Identity This property is required. boolean - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- gcp
Service Account Json This property is required. string - 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
. - gcp
Use Service Account This property is required. boolean - Use service account auth for GCP-based providers and models.
- header
Name This property is required. string - If AI model requires authentication via Authorization or API key header, specify its name here.
- header
Value This property is required. string - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- param
Location This property is required. string - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- param
Name This property is required. string - If AI model requires authentication via query parameter, specify its name here.
- param
Value This property is required. string - Specify the full parameter value for 'param_name'.
- allow_
override This property is required. bool - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- aws_
access_ key_ id This property is required. str - 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 This property is required. str - 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.
- azure_
client_ id This property is required. str - 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 This property is required. str - 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 This property is required. str - 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.
- azure_
use_ managed_ identity This property is required. bool - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- gcp_
service_ account_ json This property is required. str - 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
. - gcp_
use_ service_ account This property is required. bool - Use service account auth for GCP-based providers and models.
- header_
name This property is required. str - If AI model requires authentication via Authorization or API key header, specify its name here.
- header_
value This property is required. str - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- param_
location This property is required. str - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- param_
name This property is required. str - If AI model requires authentication via query parameter, specify its name here.
- param_
value This property is required. str - Specify the full parameter value for 'param_name'.
- allow
Override This property is required. Boolean - If enabled, the authorization header or parameter can be overridden in the request by the value configured in the plugin.
- aws
Access Key Id This property is required. String - 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 This property is required. String - 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.
- azure
Client Id This property is required. String - 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 This property is required. String - 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 This property is required. String - 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.
- azure
Use Managed Identity This property is required. Boolean - Set true to use the Azure Cloud Managed Identity (or user-assigned identity) to authenticate with Azure-provider models.
- gcp
Service Account Json This property is required. String - 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
. - gcp
Use Service Account This property is required. Boolean - Use service account auth for GCP-based providers and models.
- header
Name This property is required. String - If AI model requires authentication via Authorization or API key header, specify its name here.
- header
Value This property is required. String - Specify the full auth header value for 'header_name', for example 'Bearer key' or just 'key'.
- param
Location This property is required. String - Specify whether the 'param_name' and 'param_value' options go in a query string, or the POST form/JSON body.
- param
Name This property is required. String - If AI model requires authentication via query parameter, specify its name here.
- param
Value This property is required. String - Specify the full parameter value for 'param_name'.
GetGatewayPluginAiProxyAdvancedConfigTargetLogging
- Log
Payloads This property is required. bool - If enabled, will log the request and response body into the Kong log plugin(s) output.
- Log
Statistics This property is required. bool - If enabled and supported by the driver, will add model usage and token metrics into the Kong log plugin(s) output.
- Log
Payloads This property is required. bool - If enabled, will log the request and response body into the Kong log plugin(s) output.
- Log
Statistics This property is required. bool - If enabled and supported by the driver, will add model usage and token metrics into the Kong log plugin(s) output.
- log
Payloads This property is required. Boolean - If enabled, will log the request and response body into the Kong log plugin(s) output.
- log
Statistics This property is required. Boolean - If enabled and supported by the driver, will add model usage and token metrics into the Kong log plugin(s) output.
- log
Payloads This property is required. boolean - If enabled, will log the request and response body into the Kong log plugin(s) output.
- log
Statistics This property is required. boolean - If enabled and supported by the driver, will add model usage and token metrics into the Kong log plugin(s) output.
- log_
payloads This property is required. bool - If enabled, will log the request and response body into the Kong log plugin(s) output.
- log_
statistics This property is required. bool - If enabled and supported by the driver, will add model usage and token metrics into the Kong log plugin(s) output.
- log
Payloads This property is required. Boolean - If enabled, will log the request and response body into the Kong log plugin(s) output.
- log
Statistics This property is required. Boolean - If enabled and supported by the driver, will add model usage and token metrics into the Kong log plugin(s) output.
GetGatewayPluginAiProxyAdvancedConfigTargetModel
- Name
This property is required. string - Model name to execute.
- Options
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options - Key/value settings for the model
- Provider
This property is required. string - AI provider request format - Kong translates requests to and from the specified backend compatible formats.
- Name
This property is required. string - Model name to execute.
- Options
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options - Key/value settings for the model
- Provider
This property is required. string - AI provider request format - Kong translates requests to and from the specified backend compatible formats.
- name
This property is required. String - Model name to execute.
- options
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options - Key/value settings for the model
- provider
This property is required. String - AI provider request format - Kong translates requests to and from the specified backend compatible formats.
- name
This property is required. string - Model name to execute.
- options
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options - Key/value settings for the model
- provider
This property is required. string - AI provider request format - Kong translates requests to and from the specified backend compatible formats.
- name
This property is required. str - Model name to execute.
- options
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options - Key/value settings for the model
- provider
This property is required. str - AI provider request format - Kong translates requests to and from the specified backend compatible formats.
- name
This property is required. String - Model name to execute.
- options
This property is required. Property Map - Key/value settings for the model
- provider
This property is required. String - AI provider request format - Kong translates requests to and from the specified backend compatible formats.
GetGatewayPluginAiProxyAdvancedConfigTargetModelOptions
- Anthropic
Version This property is required. string - Defines the schema/API version, if using Anthropic provider.
- Azure
Api Version This property is required. string - 'api-version' for Azure OpenAI instances.
- Azure
Deployment Id This property is required. string - Deployment ID for Azure OpenAI instances.
- Azure
Instance This property is required. string - Instance name for Azure OpenAI hosted models.
- Bedrock
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Bedrock - Gemini
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Gemini - Huggingface
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Huggingface - Input
Cost This property is required. double - Defines the cost per 1M tokens in your prompt.
- Llama2Format
This property is required. string - If using llama2 provider, select the upstream message format.
- Max
Tokens This property is required. double - Defines the max_tokens, if using chat or completion models.
- Mistral
Format This property is required. string - If using mistral provider, select the upstream message format.
- Output
Cost This property is required. double - Defines the cost per 1M tokens in the output of the AI.
- Temperature
This property is required. double - Defines the matching temperature, if using chat or completion models.
- Top
K This property is required. double - Defines the top-k most likely tokens, if supported.
- Top
P This property is required. double - Defines the top-p probability mass, if supported.
- Upstream
Path This property is required. string - Manually specify or override the AI operation path, used when e.g. using the 'preserve' route_type.
- Upstream
Url This property is required. string - Manually specify or override the full URL to the AI operation endpoints, when calling (self-)hosted models, or for running via a private endpoint.
- Anthropic
Version This property is required. string - Defines the schema/API version, if using Anthropic provider.
- Azure
Api Version This property is required. string - 'api-version' for Azure OpenAI instances.
- Azure
Deployment Id This property is required. string - Deployment ID for Azure OpenAI instances.
- Azure
Instance This property is required. string - Instance name for Azure OpenAI hosted models.
- Bedrock
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Bedrock - Gemini
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Gemini - Huggingface
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Huggingface - Input
Cost This property is required. float64 - Defines the cost per 1M tokens in your prompt.
- Llama2Format
This property is required. string - If using llama2 provider, select the upstream message format.
- Max
Tokens This property is required. float64 - Defines the max_tokens, if using chat or completion models.
- Mistral
Format This property is required. string - If using mistral provider, select the upstream message format.
- Output
Cost This property is required. float64 - Defines the cost per 1M tokens in the output of the AI.
- Temperature
This property is required. float64 - Defines the matching temperature, if using chat or completion models.
- Top
K This property is required. float64 - Defines the top-k most likely tokens, if supported.
- Top
P This property is required. float64 - Defines the top-p probability mass, if supported.
- Upstream
Path This property is required. string - Manually specify or override the AI operation path, used when e.g. using the 'preserve' route_type.
- Upstream
Url This property is required. string - Manually specify or override the full URL to the AI operation endpoints, when calling (self-)hosted models, or for running via a private endpoint.
- anthropic
Version This property is required. String - Defines the schema/API version, if using Anthropic provider.
- azure
Api Version This property is required. String - 'api-version' for Azure OpenAI instances.
- azure
Deployment Id This property is required. String - Deployment ID for Azure OpenAI instances.
- azure
Instance This property is required. String - Instance name for Azure OpenAI hosted models.
- bedrock
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Bedrock - gemini
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Gemini - huggingface
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Huggingface - input
Cost This property is required. Double - Defines the cost per 1M tokens in your prompt.
- llama2Format
This property is required. String - If using llama2 provider, select the upstream message format.
- max
Tokens This property is required. Double - Defines the max_tokens, if using chat or completion models.
- mistral
Format This property is required. String - If using mistral provider, select the upstream message format.
- output
Cost This property is required. Double - Defines the cost per 1M tokens in the output of the AI.
- temperature
This property is required. Double - Defines the matching temperature, if using chat or completion models.
- top
K This property is required. Double - Defines the top-k most likely tokens, if supported.
- top
P This property is required. Double - Defines the top-p probability mass, if supported.
- upstream
Path This property is required. String - Manually specify or override the AI operation path, used when e.g. using the 'preserve' route_type.
- upstream
Url This property is required. String - Manually specify or override the full URL to the AI operation endpoints, when calling (self-)hosted models, or for running via a private endpoint.
- anthropic
Version This property is required. string - Defines the schema/API version, if using Anthropic provider.
- azure
Api Version This property is required. string - 'api-version' for Azure OpenAI instances.
- azure
Deployment Id This property is required. string - Deployment ID for Azure OpenAI instances.
- azure
Instance This property is required. string - Instance name for Azure OpenAI hosted models.
- bedrock
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Bedrock - gemini
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Gemini - huggingface
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Huggingface - input
Cost This property is required. number - Defines the cost per 1M tokens in your prompt.
- llama2Format
This property is required. string - If using llama2 provider, select the upstream message format.
- max
Tokens This property is required. number - Defines the max_tokens, if using chat or completion models.
- mistral
Format This property is required. string - If using mistral provider, select the upstream message format.
- output
Cost This property is required. number - Defines the cost per 1M tokens in the output of the AI.
- temperature
This property is required. number - Defines the matching temperature, if using chat or completion models.
- top
K This property is required. number - Defines the top-k most likely tokens, if supported.
- top
P This property is required. number - Defines the top-p probability mass, if supported.
- upstream
Path This property is required. string - Manually specify or override the AI operation path, used when e.g. using the 'preserve' route_type.
- upstream
Url This property is required. string - Manually specify or override the full URL to the AI operation endpoints, when calling (self-)hosted models, or for running via a private endpoint.
- anthropic_
version This property is required. str - Defines the schema/API version, if using Anthropic provider.
- azure_
api_ version This property is required. str - 'api-version' for Azure OpenAI instances.
- azure_
deployment_ id This property is required. str - Deployment ID for Azure OpenAI instances.
- azure_
instance This property is required. str - Instance name for Azure OpenAI hosted models.
- bedrock
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Bedrock - gemini
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Gemini - huggingface
This property is required. GetGateway Plugin Ai Proxy Advanced Config Target Model Options Huggingface - input_
cost This property is required. float - Defines the cost per 1M tokens in your prompt.
- llama2_
format This property is required. str - If using llama2 provider, select the upstream message format.
- max_
tokens This property is required. float - Defines the max_tokens, if using chat or completion models.
- mistral_
format This property is required. str - If using mistral provider, select the upstream message format.
- output_
cost This property is required. float - Defines the cost per 1M tokens in the output of the AI.
- temperature
This property is required. float - Defines the matching temperature, if using chat or completion models.
- top_
k This property is required. float - Defines the top-k most likely tokens, if supported.
- top_
p This property is required. float - Defines the top-p probability mass, if supported.
- upstream_
path This property is required. str - Manually specify or override the AI operation path, used when e.g. using the 'preserve' route_type.
- upstream_
url This property is required. str - Manually specify or override the full URL to the AI operation endpoints, when calling (self-)hosted models, or for running via a private endpoint.
- anthropic
Version This property is required. String - Defines the schema/API version, if using Anthropic provider.
- azure
Api Version This property is required. String - 'api-version' for Azure OpenAI instances.
- azure
Deployment Id This property is required. String - Deployment ID for Azure OpenAI instances.
- azure
Instance This property is required. String - Instance name for Azure OpenAI hosted models.
- bedrock
This property is required. Property Map - gemini
This property is required. Property Map - huggingface
This property is required. Property Map - input
Cost This property is required. Number - Defines the cost per 1M tokens in your prompt.
- llama2Format
This property is required. String - If using llama2 provider, select the upstream message format.
- max
Tokens This property is required. Number - Defines the max_tokens, if using chat or completion models.
- mistral
Format This property is required. String - If using mistral provider, select the upstream message format.
- output
Cost This property is required. Number - Defines the cost per 1M tokens in the output of the AI.
- temperature
This property is required. Number - Defines the matching temperature, if using chat or completion models.
- top
K This property is required. Number - Defines the top-k most likely tokens, if supported.
- top
P This property is required. Number - Defines the top-p probability mass, if supported.
- upstream
Path This property is required. String - Manually specify or override the AI operation path, used when e.g. using the 'preserve' route_type.
- upstream
Url This property is required. String - Manually specify or override the full URL to the AI operation endpoints, when calling (self-)hosted models, or for running via a private endpoint.
GetGatewayPluginAiProxyAdvancedConfigTargetModelOptionsBedrock
- Aws
Region This property is required. string - If using AWS providers (Bedrock) you can override the
AWS_REGION
environment variable by setting this option.
- Aws
Region This property is required. string - If using AWS providers (Bedrock) you can override the
AWS_REGION
environment variable by setting this option.
- aws
Region This property is required. String - If using AWS providers (Bedrock) you can override the
AWS_REGION
environment variable by setting this option.
- aws
Region This property is required. string - If using AWS providers (Bedrock) you can override the
AWS_REGION
environment variable by setting this option.
- aws_
region This property is required. str - If using AWS providers (Bedrock) you can override the
AWS_REGION
environment variable by setting this option.
- aws
Region This property is required. String - If using AWS providers (Bedrock) you can override the
AWS_REGION
environment variable by setting this option.
GetGatewayPluginAiProxyAdvancedConfigTargetModelOptionsGemini
- Api
Endpoint This property is required. string - If running Gemini on Vertex, specify the regional API endpoint (hostname only).
- Location
Id This property is required. string - If running Gemini on Vertex, specify the location ID.
- Project
Id This property is required. string - If running Gemini on Vertex, specify the project ID.
- Api
Endpoint This property is required. string - If running Gemini on Vertex, specify the regional API endpoint (hostname only).
- Location
Id This property is required. string - If running Gemini on Vertex, specify the location ID.
- Project
Id This property is required. string - If running Gemini on Vertex, specify the project ID.
- api
Endpoint This property is required. String - If running Gemini on Vertex, specify the regional API endpoint (hostname only).
- location
Id This property is required. String - If running Gemini on Vertex, specify the location ID.
- project
Id This property is required. String - If running Gemini on Vertex, specify the project ID.
- api
Endpoint This property is required. string - If running Gemini on Vertex, specify the regional API endpoint (hostname only).
- location
Id This property is required. string - If running Gemini on Vertex, specify the location ID.
- project
Id This property is required. string - If running Gemini on Vertex, specify the project ID.
- api_
endpoint This property is required. str - If running Gemini on Vertex, specify the regional API endpoint (hostname only).
- location_
id This property is required. str - If running Gemini on Vertex, specify the location ID.
- project_
id This property is required. str - If running Gemini on Vertex, specify the project ID.
- api
Endpoint This property is required. String - If running Gemini on Vertex, specify the regional API endpoint (hostname only).
- location
Id This property is required. String - If running Gemini on Vertex, specify the location ID.
- project
Id This property is required. String - If running Gemini on Vertex, specify the project ID.
GetGatewayPluginAiProxyAdvancedConfigTargetModelOptionsHuggingface
- Use
Cache This property is required. bool - Use the cache layer on the inference API
- Wait
For Model This property is required. bool - Wait for the model if it is not ready
- Use
Cache This property is required. bool - Use the cache layer on the inference API
- Wait
For Model This property is required. bool - Wait for the model if it is not ready
- use
Cache This property is required. Boolean - Use the cache layer on the inference API
- wait
For Model This property is required. Boolean - Wait for the model if it is not ready
- use
Cache This property is required. boolean - Use the cache layer on the inference API
- wait
For Model This property is required. boolean - Wait for the model if it is not ready
- use_
cache This property is required. bool - Use the cache layer on the inference API
- wait_
for_ model This property is required. bool - Wait for the model if it is not ready
- use
Cache This property is required. Boolean - Use the cache layer on the inference API
- wait
For Model This property is required. Boolean - Wait for the model if it is not ready
GetGatewayPluginAiProxyAdvancedConfigVectordb
- Dimensions
This property is required. double - the desired dimensionality for the vectors
- Distance
Metric This property is required. string - the distance metric to use for vector searches
- Redis
This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis - Strategy
This property is required. string - which vector database driver to use
- Threshold
This property is required. double - the default similarity threshold for accepting semantic search results (float)
- Dimensions
This property is required. float64 - the desired dimensionality for the vectors
- Distance
Metric This property is required. string - the distance metric to use for vector searches
- Redis
This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis - Strategy
This property is required. string - which vector database driver to use
- Threshold
This property is required. float64 - the default similarity threshold for accepting semantic search results (float)
- dimensions
This property is required. Double - the desired dimensionality for the vectors
- distance
Metric This property is required. String - the distance metric to use for vector searches
- redis
This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis - strategy
This property is required. String - which vector database driver to use
- threshold
This property is required. Double - the default similarity threshold for accepting semantic search results (float)
- dimensions
This property is required. number - the desired dimensionality for the vectors
- distance
Metric This property is required. string - the distance metric to use for vector searches
- redis
This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis - strategy
This property is required. string - which vector database driver to use
- threshold
This property is required. number - the default similarity threshold for accepting semantic search results (float)
- dimensions
This property is required. float - the desired dimensionality for the vectors
- distance_
metric This property is required. str - the distance metric to use for vector searches
- redis
This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis - strategy
This property is required. str - which vector database driver to use
- threshold
This property is required. float - the default similarity threshold for accepting semantic search results (float)
- dimensions
This property is required. Number - the desired dimensionality for the vectors
- distance
Metric This property is required. String - the distance metric to use for vector searches
- redis
This property is required. Property Map - strategy
This property is required. String - which vector database driver to use
- threshold
This property is required. Number - the default similarity threshold for accepting semantic search results (float)
GetGatewayPluginAiProxyAdvancedConfigVectordbRedis
- Cluster
Max Redirections This property is required. double - Maximum retry attempts for redirection.
- Cluster
Nodes This property is required. List<GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis Cluster Node> - 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. - Connect
Timeout This property is required. double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Connection
Is Proxied This property is required. bool - If the connection to Redis is proxied (e.g. Envoy), set it
true
. Set thehost
andport
to point to the proxy address. - Database
This property is required. double - Database to use for the Redis connection when using the
redis
strategy - Host
This property is required. string - A string representing a host name, such as example.com.
- Keepalive
Backlog This property is required. double - 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 thankeepalive_pool_size
. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size
. - Keepalive
Pool Size This property is required. double - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_size
norkeepalive_backlog
is specified, no pool is created. Ifkeepalive_pool_size
isn't specified butkeepalive_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. - Password
This property is required. string - Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- Port
This property is required. double - An integer representing a port number between 0 and 65535, inclusive.
- Read
Timeout This property is required. double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Send
Timeout This property is required. double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Sentinel
Master This property is required. string - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- Sentinel
Nodes This property is required. List<GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis Sentinel Node> - 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. - Sentinel
Password This property is required. string - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- Sentinel
Role This property is required. string - Sentinel role to use for Redis connections when the
redis
strategy is defined. Defining this value implies using Redis Sentinel. - Sentinel
Username This property is required. string - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- Server
Name This property is required. string - A string representing an SNI (server name indication) value for TLS.
- Ssl
This property is required. bool - If set to true, uses SSL to connect to Redis.
- Ssl
Verify This property is required. bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificate
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depth
accordingly. - Username
This property is required. string - 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
.
- Cluster
Max Redirections This property is required. float64 - Maximum retry attempts for redirection.
- Cluster
Nodes This property is required. []GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis Cluster Node - 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. - Connect
Timeout This property is required. float64 - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Connection
Is Proxied This property is required. bool - If the connection to Redis is proxied (e.g. Envoy), set it
true
. Set thehost
andport
to point to the proxy address. - Database
This property is required. float64 - Database to use for the Redis connection when using the
redis
strategy - Host
This property is required. string - A string representing a host name, such as example.com.
- Keepalive
Backlog This property is required. float64 - 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 thankeepalive_pool_size
. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size
. - Keepalive
Pool Size This property is required. float64 - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_size
norkeepalive_backlog
is specified, no pool is created. Ifkeepalive_pool_size
isn't specified butkeepalive_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. - Password
This property is required. string - Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- Port
This property is required. float64 - An integer representing a port number between 0 and 65535, inclusive.
- Read
Timeout This property is required. float64 - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Send
Timeout This property is required. float64 - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Sentinel
Master This property is required. string - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- Sentinel
Nodes This property is required. []GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis Sentinel Node - 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. - Sentinel
Password This property is required. string - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- Sentinel
Role This property is required. string - Sentinel role to use for Redis connections when the
redis
strategy is defined. Defining this value implies using Redis Sentinel. - Sentinel
Username This property is required. string - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- Server
Name This property is required. string - A string representing an SNI (server name indication) value for TLS.
- Ssl
This property is required. bool - If set to true, uses SSL to connect to Redis.
- Ssl
Verify This property is required. bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificate
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depth
accordingly. - Username
This property is required. string - 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
.
- cluster
Max Redirections This property is required. Double - Maximum retry attempts for redirection.
- cluster
Nodes This property is required. List<GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis Cluster Node> - 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. - connect
Timeout This property is required. Double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection
Is Proxied This property is required. Boolean - If the connection to Redis is proxied (e.g. Envoy), set it
true
. Set thehost
andport
to point to the proxy address. - database
This property is required. Double - Database to use for the Redis connection when using the
redis
strategy - host
This property is required. String - A string representing a host name, such as example.com.
- keepalive
Backlog This property is required. Double - 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 thankeepalive_pool_size
. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size
. - keepalive
Pool Size This property is required. Double - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_size
norkeepalive_backlog
is specified, no pool is created. Ifkeepalive_pool_size
isn't specified butkeepalive_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. - password
This property is required. String - Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port
This property is required. Double - An integer representing a port number between 0 and 65535, inclusive.
- read
Timeout This property is required. Double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- send
Timeout This property is required. Double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel
Master This property is required. String - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel
Nodes This property is required. List<GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis Sentinel Node> - 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. - sentinel
Password This property is required. String - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel
Role This property is required. String - Sentinel role to use for Redis connections when the
redis
strategy is defined. Defining this value implies using Redis Sentinel. - sentinel
Username This property is required. String - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- server
Name This property is required. String - A string representing an SNI (server name indication) value for TLS.
- ssl
This property is required. Boolean - If set to true, uses SSL to connect to Redis.
- ssl
Verify This property is required. Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificate
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depth
accordingly. - username
This property is required. String - 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
.
- cluster
Max Redirections This property is required. number - Maximum retry attempts for redirection.
- cluster
Nodes This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis Cluster Node[] - 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. - connect
Timeout This property is required. number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection
Is Proxied This property is required. boolean - If the connection to Redis is proxied (e.g. Envoy), set it
true
. Set thehost
andport
to point to the proxy address. - database
This property is required. number - Database to use for the Redis connection when using the
redis
strategy - host
This property is required. string - A string representing a host name, such as example.com.
- keepalive
Backlog This property is required. number - 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 thankeepalive_pool_size
. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size
. - keepalive
Pool Size This property is required. number - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_size
norkeepalive_backlog
is specified, no pool is created. Ifkeepalive_pool_size
isn't specified butkeepalive_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. - password
This property is required. string - Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port
This property is required. number - An integer representing a port number between 0 and 65535, inclusive.
- read
Timeout This property is required. number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- send
Timeout This property is required. number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel
Master This property is required. string - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel
Nodes This property is required. GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis Sentinel Node[] - 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. - sentinel
Password This property is required. string - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel
Role This property is required. string - Sentinel role to use for Redis connections when the
redis
strategy is defined. Defining this value implies using Redis Sentinel. - sentinel
Username This property is required. string - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- server
Name This property is required. string - A string representing an SNI (server name indication) value for TLS.
- ssl
This property is required. boolean - If set to true, uses SSL to connect to Redis.
- ssl
Verify This property is required. boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificate
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depth
accordingly. - username
This property is required. string - 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
.
- cluster_
max_ redirections This property is required. float - Maximum retry attempts for redirection.
- cluster_
nodes This property is required. Sequence[GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis Cluster Node] - 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. - connect_
timeout This property is required. float - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection_
is_ proxied This property is required. bool - If the connection to Redis is proxied (e.g. Envoy), set it
true
. Set thehost
andport
to point to the proxy address. - database
This property is required. float - Database to use for the Redis connection when using the
redis
strategy - host
This property is required. str - A string representing a host name, such as example.com.
- keepalive_
backlog This property is required. float - 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 thankeepalive_pool_size
. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size
. - keepalive_
pool_ size This property is required. float - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_size
norkeepalive_backlog
is specified, no pool is created. Ifkeepalive_pool_size
isn't specified butkeepalive_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. - password
This property is required. str - Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port
This property is required. float - An integer representing a port number between 0 and 65535, inclusive.
- read_
timeout This property is required. float - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- send_
timeout This property is required. float - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel_
master This property is required. str - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel_
nodes This property is required. Sequence[GetGateway Plugin Ai Proxy Advanced Config Vectordb Redis Sentinel Node] - 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. - sentinel_
password This property is required. str - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel_
role This property is required. str - Sentinel role to use for Redis connections when the
redis
strategy is defined. Defining this value implies using Redis Sentinel. - sentinel_
username This property is required. str - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- server_
name This property is required. str - A string representing an SNI (server name indication) value for TLS.
- ssl
This property is required. bool - If set to true, uses SSL to connect to Redis.
- ssl_
verify This property is required. bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificate
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depth
accordingly. - username
This property is required. str - 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
.
- cluster
Max Redirections This property is required. Number - Maximum retry attempts for redirection.
- cluster
Nodes This property is required. List<Property Map> - 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. - connect
Timeout This property is required. Number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection
Is Proxied This property is required. Boolean - If the connection to Redis is proxied (e.g. Envoy), set it
true
. Set thehost
andport
to point to the proxy address. - database
This property is required. Number - Database to use for the Redis connection when using the
redis
strategy - host
This property is required. String - A string representing a host name, such as example.com.
- keepalive
Backlog This property is required. Number - 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 thankeepalive_pool_size
. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size
. - keepalive
Pool Size This property is required. Number - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_size
norkeepalive_backlog
is specified, no pool is created. Ifkeepalive_pool_size
isn't specified butkeepalive_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. - password
This property is required. String - Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port
This property is required. Number - An integer representing a port number between 0 and 65535, inclusive.
- read
Timeout This property is required. Number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- send
Timeout This property is required. Number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel
Master This property is required. String - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel
Nodes This property is required. List<Property Map> - 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. - sentinel
Password This property is required. String - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel
Role This property is required. String - Sentinel role to use for Redis connections when the
redis
strategy is defined. Defining this value implies using Redis Sentinel. - sentinel
Username This property is required. String - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- server
Name This property is required. String - A string representing an SNI (server name indication) value for TLS.
- ssl
This property is required. Boolean - If set to true, uses SSL to connect to Redis.
- ssl
Verify This property is required. Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificate
inkong.conf
to specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depth
accordingly. - username
This property is required. String - 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
.
GetGatewayPluginAiProxyAdvancedConfigVectordbRedisClusterNode
GetGatewayPluginAiProxyAdvancedConfigVectordbRedisSentinelNode
GetGatewayPluginAiProxyAdvancedConsumer
- Id
This property is required. string
- Id
This property is required. string
- id
This property is required. String
- id
This property is required. string
- id
This property is required. str
- id
This property is required. String
GetGatewayPluginAiProxyAdvancedConsumerGroup
- Id
This property is required. string
- Id
This property is required. string
- id
This property is required. String
- id
This property is required. string
- id
This property is required. str
- id
This property is required. String
GetGatewayPluginAiProxyAdvancedOrdering
- After
This property is required. GetGateway Plugin Ai Proxy Advanced Ordering After - Before
This property is required. GetGateway Plugin Ai Proxy Advanced Ordering Before
- After
This property is required. GetGateway Plugin Ai Proxy Advanced Ordering After - Before
This property is required. GetGateway Plugin Ai Proxy Advanced Ordering Before
- after
This property is required. GetGateway Plugin Ai Proxy Advanced Ordering After - before
This property is required. GetGateway Plugin Ai Proxy Advanced Ordering Before
- after
This property is required. GetGateway Plugin Ai Proxy Advanced Ordering After - before
This property is required. GetGateway Plugin Ai Proxy Advanced Ordering Before
- after
This property is required. GetGateway Plugin Ai Proxy Advanced Ordering After - before
This property is required. GetGateway Plugin Ai Proxy Advanced Ordering Before
- after
This property is required. Property Map - before
This property is required. Property Map
GetGatewayPluginAiProxyAdvancedOrderingAfter
- Accesses
This property is required. List<string>
- Accesses
This property is required. []string
- accesses
This property is required. List<String>
- accesses
This property is required. string[]
- accesses
This property is required. Sequence[str]
- accesses
This property is required. List<String>
GetGatewayPluginAiProxyAdvancedOrderingBefore
- Accesses
This property is required. List<string>
- Accesses
This property is required. []string
- accesses
This property is required. List<String>
- accesses
This property is required. string[]
- accesses
This property is required. Sequence[str]
- accesses
This property is required. List<String>
GetGatewayPluginAiProxyAdvancedRoute
- Id
This property is required. string
- Id
This property is required. string
- id
This property is required. String
- id
This property is required. string
- id
This property is required. str
- id
This property is required. String
GetGatewayPluginAiProxyAdvancedService
- Id
This property is required. string
- Id
This property is required. string
- id
This property is required. String
- id
This property is required. string
- id
This property is required. str
- id
This property is required. String
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the
konnect
Terraform Provider.