custom model dosc

Kong · Sep 26, 2024 · c8341f7 · c8341f7
1 parent dcc5f1c
commit c8341f7
Show file tree

Hide file tree

Showing 14 changed files with 81 additions and 0 deletions.
diff --git a/...kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_anthropic.md b/...kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_anthropic.md
@@ -66,3 +66,4 @@ curl -X POST http://localhost:8000/anthropic-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+{% include_cached /md/plugins-hub/ai-custom-model-advanced.md %}
diff --git a/...hub/kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_azure.md b/...hub/kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_azure.md
@@ -77,3 +77,5 @@ curl -X POST http://localhost:8000/azure-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+
+{% include_cached /md/plugins-hub/ai-custom-model-advanced.md %}
diff --git a/...ub/kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_cohere.md b/...ub/kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_cohere.md
@@ -64,3 +64,5 @@ curl -X POST http://localhost:8000/cohere-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+
+{% include_cached /md/plugins-hub/ai-custom-model-advanced.md %}
diff --git a/...ub/kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_llama2.md b/...ub/kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_llama2.md
@@ -112,3 +112,4 @@ curl -X POST http://localhost:8000/llama2-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+{% include_cached /md/plugins-hub/ai-custom-model-advanced.md %}
diff --git a/...b/kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_mistral.md b/...b/kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_mistral.md
@@ -103,3 +103,4 @@ curl -X POST http://localhost:8000/mistral-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+{% include_cached /md/plugins-hub/ai-custom-model-advanced.md %}
diff --git a/...ub/kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_openai.md b/...ub/kong-inc/ai-proxy-advanced/how-to/llm-provider-integration-guides/_openai.md
@@ -55,6 +55,7 @@ formats:
 {% endplugin_example %}
 <!--vale on-->
 
+
 ### Test the configuration
 
 Make an `llm/v1/chat` type request to test your new endpoint:
@@ -64,3 +65,4 @@ curl -X POST http://localhost:8000/openai-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+{% include_cached /md/plugins-hub/ai-custom-model-advanced.md %}
diff --git a/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_anthropic.md b/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_anthropic.md
@@ -82,3 +82,4 @@ curl -X POST http://localhost:8000/anthropic-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+{% include_cached /md/plugins-hub/ai-custom-model.md %}
diff --git a/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_azure.md b/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_azure.md
@@ -89,3 +89,4 @@ curl -X POST http://localhost:8000/azure-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+{% include_cached /md/plugins-hub/ai-custom-model.md %}
diff --git a/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_cohere.md b/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_cohere.md
@@ -76,3 +76,5 @@ curl -X POST http://localhost:8000/cohere-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+
+{% include_cached /md/plugins-hub/ai-custom-model.md %}
diff --git a/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_llama2.md b/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_llama2.md
@@ -123,3 +123,5 @@ curl -X POST http://localhost:8000/llama2-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+
+{% include_cached /md/plugins-hub/ai-custom-model.md %}
diff --git a/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_mistral.md b/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_mistral.md
@@ -115,3 +115,4 @@ curl -X POST http://localhost:8000/mistral-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+{% include_cached /md/plugins-hub/ai-custom-model.md %}
diff --git a/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_openai.md b/app/_hub/kong-inc/ai-proxy/how-to/llm-provider-integration-guides/_openai.md
@@ -76,3 +76,4 @@ curl -X POST http://localhost:8000/openai-chat \
   -H 'Content-Type: application/json' \
   --data-raw '{ "messages": [ { "role": "system", "content": "You are a mathematician" }, { "role": "user", "content": "What is 1+1?"} ] }'
 ```
+{% include_cached /md/plugins-hub/ai-custom-model.md %}
diff --git a/app/_includes/md/plugins-hub/ai-custom-model-advanced.md b/app/_includes/md/plugins-hub/ai-custom-model-advanced.md
@@ -0,0 +1,32 @@
+
+For all providers, the Kong AI Proxy Advanced plugin attaches to **route** entities.
+
+### Custom model
+
+You can configure the AI Proxy Advanced Plugin using a custom model of your choice by setting the `name` and `upstream_url` when configuring the model. 
+
+<!--vale off-->
+{% plugin_example %}
+plugin: kong-inc/ai-proxy-advanced
+name: ai-proxy-advanced
+config:
+  targets:
+  - route_type: "llm/v1/chat"
+    auth:
+      header_name: "Authorization"
+      header_value: "Bearer <openai_key>"
+  - model:
+      name: custom_model_name
+      provider: openai|azure|anthropic|cohere|mistral|llama2|gemini|bedrock
+      options:
+        upstream_url: http://localhost:8000/vi/chat/completions
+targets:
+  - route
+formats:
+  - curl
+  - konnect
+  - yaml
+  - kubernetes
+  - terraform
+{% endplugin_example %}
+<!--vale on-->
diff --git a/app/_includes/md/plugins-hub/ai-custom-model.md b/app/_includes/md/plugins-hub/ai-custom-model.md
@@ -0,0 +1,32 @@
+
+For all providers, the Kong AI Proxy Advanced plugin attaches to **route** entities.
+
+### Custom model
+
+You can configure the AI Proxy Advanced Plugin using a custom model of your choice by setting the `name` and `upstream_url` when configuring the model. 
+
+<!--vale off-->
+{% plugin_example %}
+plugin: kong-inc/ai-proxy-advanced
+name: ai-proxy-advanced
+config:
+  targets:
+  - route_type: "llm/v1/chat"
+    auth:
+      header_name: "Authorization"
+      header_value: "Bearer <openai_key>"
+  - model:
+      name: custom_model_name
+      provider: openai|azure|anthropic|cohere|mistral|llama2|gemini|bedrock
+      options:
+        upstream_url: http://localhost:8000/vi/chat/completions
+targets:
+  - route
+formats:
+  - curl
+  - konnect
+  - yaml
+  - kubernetes
+  - terraform
+{% endplugin_example %}
+<!--vale on-->