16 KiB
title, keywords, description
| title | keywords | description | ||
|---|---|---|---|---|
| AI 缓存 |
|
AI 缓存插件配置参考 |
Note
若使用 tinygo 编译，则需要数据面的proxy wasm版本大于等于0.2.100，且编译时需要带上版本的tag，例如：
tinygo build -o main.wasm -scheduler=none -target=wasi -gc=custom -tags="custommalloc nottinygc_finalizer proxy_wasm_version_0_2_100" ./
功能说明
LLM 结果缓存插件，默认配置方式可以直接用于 openai 协议的结果缓存，同时支持流式和非流式响应的缓存。
提示
携带请求头x-higress-skip-ai-cache: on时，当前请求将不会使用缓存中的内容，而是直接转发给后端服务，同时也不会缓存该请求返回响应的内容
运行属性
插件执行阶段：认证阶段
插件执行优先级：10
配置说明
配置分为 3 个部分：向量数据库（vector）；文本向量化接口（embedding）；缓存数据库（cache），同时也提供了细粒度的 LLM 请求/响应提取参数配置等。
配置说明
本插件同时支持基于向量数据库的语义化缓存和基于字符串匹配的缓存方法，如果同时配置了向量数据库和缓存数据库，优先使用缓存数据库，未命中场景下使用向量数据库能力。
Note: 向量数据库(vector) 和 缓存数据库(cache) 不能同时为空，否则本插件无法提供缓存服务。
| Name | Type | Requirement | Default | Description |
|---|---|---|---|---|
| vector | object | optional | - | 向量存储服务配置，详见下文向量数据库服务配置 |
| embedding | object | optional | - | 文本向量化服务配置，详见下文文本向量化服务配置 |
| cache | object | optional | - | 缓存服务配置，详见下文缓存服务配置 |
| cacheKeyStrategy | string | optional | "lastQuestion" | 决定如何根据历史问题生成缓存键的策略。可选值: "lastQuestion" (使用最后一个问题), "allQuestions" (拼接所有问题) 或 "disabled" (禁用缓存) |
| enableSemanticCache | bool | optional | false | 是否启用语义化缓存。若不启用，则使用字符串匹配的方式来查找缓存，此时需要配置cache服务。当配置了 vector provider 时，默认自动开启 |
根据是否需要启用语义缓存，可以只配置组件的组合为:
cache: 仅启用字符串匹配缓存vector (+ embedding): 启用语义化缓存, 其中若vector未提供字符串表征服务，则需要自行配置embedding服务vector (+ embedding) + cache: 启用语义化缓存并用缓存服务存储LLM响应以加速
注意若不配置相关组件，则可以忽略相应组件的required字段。
向量数据库服务（vector）
| Name | Type | Requirement | Default | Description |
|---|---|---|---|---|
| vector.type | string | required | - | 向量存储服务提供者类型，例如 dashvector、chroma、elasticsearch、weaviate、pinecone、qdrant、milvus |
| vector.serviceName | string | required | - | 向量存储服务名称 |
| vector.serviceHost | string | optional | - | 向量存储服务域名。部分 provider（如 dashvector、pinecone）要求必填 |
| vector.servicePort | int64 | optional | 443 | 向量存储服务端口 |
| vector.apiKey | string | optional | - | 向量存储服务 API Key |
| vector.topK | int | optional | 1 | 返回TopK结果 |
| vector.timeout | uint32 | optional | 10000 | 请求向量存储服务的超时时间，单位为毫秒。默认值是10000，即10秒 |
| vector.collectionID | string | optional | - | 向量存储服务 Collection ID |
| vector.threshold | float64 | optional | 1000 | 向量相似度度量阈值 |
| vector.thresholdRelation | string | optional | "lt" | 相似度度量比较方式。相似度度量方式有 Cosine, DotProduct, Euclidean 等，前两者值越大相似度越高，后者值越小相似度越高。对于 Cosine 和 DotProduct 选择 gt，对于 Euclidean 则选择 lt。所有可选值包括 lt (less than，小于)、lte (less than or equal to，小等于)、gt (greater than，大于)、gte (greater than or equal to，大等于) |
| vector.esUsername | string | optional | - | ElasticSearch 用户名，仅用于 elasticsearch 类型 |
| vector.esPassword | string | optional | - | ElasticSearch 密码，仅用于 elasticsearch 类型 |
文本向量化服务（embedding）
| Name | Type | Requirement | Default | Description |
|---|---|---|---|---|
| embedding.type | string | required | - | 请求文本向量化服务类型，例如 dashscope、openai、azure、cohere、ollama、huggingface、textin、xfyun |
| embedding.serviceName | string | required | - | 请求文本向量化服务名称 |
| embedding.serviceHost | string | optional | - | 请求文本向量化服务域名 |
| embedding.servicePort | int64 | optional | 443 | 请求文本向量化服务端口。不同 provider 默认值可能不同，ollama 默认为 11434 |
| embedding.timeout | uint32 | optional | 10000 | 请求文本向量化服务的超时时间，单位为毫秒。默认值是10000，即10秒 |
| embedding.model | string | optional | - | 请求文本向量化服务的模型名称 |
| embedding.apiKey | string | optional | - | 请求文本向量化服务的 API Key |
缓存服务（cache）
| Name | Type | Requirement | Default | Description |
|---|---|---|---|---|
| cache.type | string | required | - | 缓存服务类型，例如 redis |
| cache.serviceName | string | required | - | 缓存服务名称 |
| cache.serviceHost | string | optional | - | 缓存服务域名 |
| cache.servicePort | int64 | optional | 6379 | 缓存服务端口。若 serviceName 以 .static 结尾，则默认值为 80 |
| cache.username | string | optional | - | 缓存服务用户名 |
| cache.password | string | optional | - | 缓存服务密码 |
| cache.timeout | uint32 | optional | 10000 | 缓存服务的超时时间，单位为毫秒。默认值是10000，即10秒 |
| cache.cacheTTL | int | optional | 0 | 缓存过期时间，单位为秒。默认值是 0，即永不过期 |
| cache.cacheKeyPrefix | string | optional | "higress-ai-cache:" | 缓存 Key 的前缀 |
| cache.database | int | optional | 0 | 使用的数据库id，仅限redis，例如配置为1，对应SELECT 1 |
其他配置
| Name | Type | Requirement | Default | Description |
|---|---|---|---|---|
| cacheKeyFrom | string | optional | "messages.@reverse.0.content" | 从请求 Body 中基于 GJSON PATH 语法提取字符串 |
| cacheValueFrom | string | optional | "choices.0.message.content" | 从响应 Body 中基于 GJSON PATH 语法提取字符串 |
| cacheStreamValueFrom | string | optional | "choices.0.delta.content" | 从流式响应 Body 中基于 GJSON PATH 语法提取字符串 |
| cacheToolCallsFrom | string | optional | "choices.0.delta.content.tool_calls" | 从流式响应 Body 中基于 GJSON PATH 语法提取字符串 |
| responseTemplate | string | optional | {"id":"from-cache","choices":[{"index":0,"message":{"role":"assistant","content":"%s"},"finish_reason":"stop"}],"model":"from-cache","object":"chat.completion","usage":{"prompt_tokens":0,"completion_tokens":0,"total_tokens":0}} |
返回 HTTP 响应的模版，用 %s 标记需要被 cache value 替换的部分 |
| streamResponseTemplate | string | optional | data:{"id":"from-cache","choices":[{"index":0,"delta":{"role":"assistant","content":"%s"},"finish_reason":"stop"}],"model":"from-cache","object":"chat.completion","usage":{"prompt_tokens":0,"completion_tokens":0,"total_tokens":0}}\n\ndata:[DONE]\n\n |
返回流式 HTTP 响应的模版，用 %s 标记需要被 cache value 替换的部分 |
文本向量化提供商特有配置
Azure OpenAI
Azure OpenAI 所对应的 embedding.type 为 azure。它需要提前创建Azure OpenAI 账户，然后您需要在Azure AI Foundry中挑选一个模型并将其部署，点击您部署好的模型，您可以在终结点中看到目标 URI 以及密钥。请将 URI 中的 host 填入embedding.serviceHost，密钥填入embedding.apiKey。
一个完整的 URI 示例为 https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings?api-version=2024-10-21，您需要将YOUR_RESOURCE_NAME.openai.azure.com填入embedding.serviceHost。
它特有的配置字段如下：
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
embedding.apiVersion |
string | 必填 | - | api版本，获取到的URI中api-version的值 |
需要注意的是您必须要指定embedding.serviceHost，如YOUR_RESOURCE_NAME.openai.azure.com。模型默认使用了text-embedding-ada-002，如需其他模型，请在embedding.model中进行指定。
Cohere
Cohere 所对应的 embedding.type 为 cohere。它并无特有的配置字段。需要提前创建 API Key，并将其填入embedding.apiKey。
OpenAI
OpenAI 所对应的 embedding.type 为 openai。它并无特有的配置字段。需要提前创建 API Key，并将其填入embedding.apiKey，一个 API Key 的示例为sk-xxxxxxx。
Ollama
Ollama 所对应的 embedding.type 为 ollama。它并无特有的配置字段。
Hugging Face
Hugging Face 所对应的 embedding.type 为 huggingface。它并无特有的配置字段。需要提前创建 hf_token，并将其填入embedding.apiKey，一个 hf_token 的示例为hf_xxxxxxx。
embedding.model默认指定为sentence-transformers/all-MiniLM-L6-v2
DashScope
DashScope 所对应的 embedding.type 为 dashscope。需要提前创建 API Key，并将其填入embedding.apiKey。
embedding.model默认指定为text-embedding-v2，还可选用text-embedding-v1等模型。
TextIn
TextIn 所对应的 embedding.type 为 textin。它需要提前获取app-id 和secret-code。
它特有的配置字段如下：
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
embedding.textinAppId |
string | 必填 | - | 应用 ID，获取的 app-id |
embedding.textinSecretCode |
string | 必填 | - | 调用 API 所需 Secret，获取的 secret-code |
embedding.textinMatryoshkaDim |
int | 必填 | - | 返回的单个向量长度 |
讯飞星火
讯飞星火 所对应的 embedding.type 为 xfyun。它需要提前创建应用，获取APPID、APISecret和APIKey，并将APIKey填入embedding.apiKey中。
它特有的配置字段如下：
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
embedding.appId |
string | 必填 | - | 应用 ID，获取的 APPID |
embedding.apiSecret |
string | 必填 | - | 调用 API 所需 Secret，获取的 APISecret |
向量数据库提供商特有配置
Chroma
Chroma 所对应的 vector.type 为 chroma。它并无特有的配置字段。需要提前创建 Collection，并填写 Collection ID 至配置项 vector.collectionID，一个 Collection ID 的示例为 52bbb8b3-724c-477b-a4ce-d5b578214612。
DashVector
DashVector 所对应的 vector.type 为 dashvector。它并无特有的配置字段。需要提前创建 Collection，并填写 Collection 名称 至配置项 vector.collectionID。
ElasticSearch
ElasticSearch 所对应的 vector.type 为 elasticsearch。需要提前创建 Index 并填写 Index Name 至配置项 vector.collectionID 。
当前依赖于 KNN 方法，请保证 ES 版本支持 KNN，当前已在 8.16 版本测试。
它特有的配置字段如下：
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
vector.esUsername |
string | 非必填 | - | ElasticSearch 用户名 |
vector.esPassword |
string | 非必填 | - | ElasticSearch 密码 |
vector.esUsername 和 vector.esPassword 用于 Basic 认证。同时也支持 Api Key 认证，当填写了 vector.apiKey 时，则启用 Api Key 认证，如果使用 SaaS 版本需要填写 encoded 的值。
Milvus
Milvus 所对应的 vector.type 为 milvus。它并无特有的配置字段。需要提前创建 Collection，并填写 Collection Name 至配置项 vector.collectionID。
Pinecone
Pinecone 所对应的 vector.type 为 pinecone。它并无特有的配置字段。需要提前创建 Index，并填写 Index 访问域名至 vector.serviceHost。
Pinecone 中的 Namespace 参数通过插件的 vector.collectionID 进行配置，如果不填写 vector.collectionID，则默认为 Default Namespace。
Qdrant
Qdrant 所对应的 vector.type 为 qdrant。它并无特有的配置字段。需要提前创建 Collection，并填写 Collection Name 至配置项 vector.collectionID。
Weaviate
Weaviate 所对应的 vector.type 为 weaviate。它并无特有的配置字段。需要提前创建 Collection，并填写 Collection Name 至配置项 vector.collectionID。
需要注意的是 Weaviate 会设置首字母自动大写，在填写配置 collectionID 的时候需要将首字母设置为大写。
如果使用 SaaS 需要填写 vector.serviceHost 参数。
配置示例
基础配置
embedding:
type: dashscope
serviceName: my_dashscope.dns
apiKey: [Your Key]
vector:
type: dashvector
serviceName: my_dashvector.dns
collectionID: [Your Collection ID]
serviceHost: [Your domain]
apiKey: [Your key]
cache:
type: redis
serviceName: my_redis.dns
servicePort: 6379
timeout: 100
进阶用法
当前默认的缓存 key 是基于 GJSON PATH 的表达式：messages.@reverse.0.content 提取，含义是把 messages 数组反转后取第一项的 content；
GJSON PATH 支持条件判断语法，例如希望取最后一个 role 为 user 的 content 作为 key，可以写成： messages.@reverse.#(role=="user").content；
如果希望将所有 role 为 user 的 content 拼成一个数组作为 key，可以写成：messages.@reverse.#(role=="user")#.content；
还可以支持管道语法，例如希望取到数第二个 role 为 user 的 content 作为 key，可以写成：messages.@reverse.#(role=="user")#.content|1。
更多用法可以参考官方文档，可以使用 GJSON Playground 进行语法测试。
常见问题
- 如果返回的错误为
error status returned by host: bad argument，请检查serviceName是否正确包含了服务的类型后缀(.dns等)。