forked from apache/apisix
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
124119c
commit 589708e
Showing
1 changed file
with
102 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
--- | ||
title: ai-prompt-template | ||
keywords: | ||
- Apache APISIX | ||
- API Gateway | ||
- Plugin | ||
- ai-prompt-template | ||
description: This document contains information about the Apache APISIX ai-prompt-template Plugin. | ||
--- | ||
|
||
<!-- | ||
# | ||
# Licensed to the Apache Software Foundation (ASF) under one or more | ||
# contributor license agreements. See the NOTICE file distributed with | ||
# this work for additional information regarding copyright ownership. | ||
# The ASF licenses this file to You under the Apache License, Version 2.0 | ||
# (the "License"); you may not use this file except in compliance with | ||
# the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
# | ||
--> | ||
|
||
## Description | ||
|
||
The `ai-prompt-template` plugin simplifies access to AI providers and models by predefining the request format | ||
using a template and allowing users to pass only the values for template variables. | ||
|
||
## Plugin Attributes | ||
|
||
| **Field** | **Type** | **Description** | **Required** | | ||
| ------------------------------------- | -------- | --------------------------------------------------- | ------------ | | ||
| `templates` | Array | An array of template objects | Yes | | ||
| `templates.name` | String | Name of the template. | Yes | | ||
| `templates.template.model` | String | Model of the AI Model. Example: gpt-4, gpt-3.5 | Yes | | ||
| `templates.template.messages.role` | String | Role of the message (`system`, `user`, `assistant`) | Yes | | ||
| `templates.template.messages.content` | String | Content of the message. | Yes | | ||
|
||
## Example usage | ||
|
||
Create a route with the `ai-prompt-template` plugin like so: | ||
|
||
```shell | ||
curl "http://127.0.0.1:9180/apisix/admin/routes/1" -X PUT \ | ||
-H "X-API-KEY: ${ADMIN_API_KEY}" \ | ||
-d '{ | ||
"uri": "/v1/chat/completions", | ||
"upstream": { | ||
"type": "roundrobin", | ||
"nodes": { | ||
"api.openai.com:443": 1 | ||
}, | ||
"scheme": "https", | ||
"pass_host": "node" | ||
}, | ||
"plugins": { | ||
"ai-prompt-template": { | ||
"templates": [ | ||
{ | ||
"name": "level of detail", | ||
"template": { | ||
"model": "gpt-4", | ||
"messages": [ | ||
{ | ||
"role": "user", | ||
"content": "Explain about {{ topic }} in {{ level }}." | ||
} | ||
] | ||
} | ||
} | ||
] | ||
} | ||
} | ||
}' | ||
``` | ||
|
||
Now send a request: | ||
|
||
```shell | ||
curl http://127.0.0.1:9080/v1/chat/completions -i -XPOST -H 'Content-Type: application/json' -d '{ | ||
"template_name": "level of detail, | ||
"topic": "psychology", | ||
"level": "brief" | ||
}' | ||
``` | ||
|
||
Then the request body will be modified to something like this: | ||
|
||
```json | ||
{ | ||
"model": "some model", | ||
"messages": [ | ||
{ "role": "user", "content": "Explain about psychology in brief." } | ||
] | ||
} | ||
``` |