API2D

修改分组

POST

/custom_key_type/update

删除之后会把分组内所有 key 的点数转回开发者账户。

请求参数

Header 参数

Content-Type

string

必需

默认值:

application/json

Authorization

string

必需

Bearer 你的forwardKey/customKey/API Token

默认值:

Bearer fk....

Body 参数application/json

integer

分组的 id

必需

name

string

分组的名字

必需

daily_quota

integer

必需

分组内 Key 的默认每日请求上限

monthly_quota

integer

必需

分组内 Key 的默认每月请求上限

system_message

string | null

可选

分组默认的 system message，会自动加到分组内 key 的请求消息中

enable_fetch

enum<integer> | enum<null>

是否开启联网功能

可选

枚举值:

fetch_keyword

string | null

可选

联网触发词，如果不设置，所有消息都会触发联网

fetch_max_tokens

number | null

可选

联网内容的最大长度，如果不设置，默认为1000

enable_vector

enum<integer> | enum<null>

是否开启知识库功能

可选

枚举值:

vector_keyword

string | null

可选

触发知识库搜索的关键字，如果留空表示每条消息都触发

vector_topk

integer | null

可选

知识库搜索返回的最大条数

vector_searchable_id

string | null

可选

知识库searchable_id

示例

{
  "id": 105,
  "name": "商品2",
  "daily_quota": 10000,
  "monthly_quota": 300000,
  "system_message": "你是一个英语老师，你需要翻译提供的内容...",
  "enable_fetch": 1,
  "fetch_keyword": "@搜索",
  "fetch_max_tokens": 2000,
  "enable_vector": 1,
  "vector_keyword": "@向量",
  "vector_topk": 2,
  "vector_searchable_id": "1313213213213123"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://oa.api2d.net/custom_key_type/update' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 105,
    "name": "商品2",
    "daily_quota": 10000,
    "monthly_quota": 300000,
    "system_message": "你是一个英语老师，你需要翻译提供的内容...",
    "enable_fetch": 1,
    "fetch_keyword": "@搜索",
    "fetch_max_tokens": 2000,
    "enable_vector": 1,
    "vector_keyword": "@向量",
    "vector_topk": 2,
    "vector_searchable_id": "1313213213213123"
}'

返回响应

🟢200OK

application/json

Body

object {0}

示例

{
  "code": 0,
  "data": {
    "custom_key_type": {
      "name": "高级会员",
      "uid": 186009,
      "updated_at": "2023-05-27T04:08:49.000000Z",
      "created_at": "2023-05-27T04:08:49.000000Z",
      "id": 290,
      "private_key": "..."
    }
  }
}

修改于 2024-06-17 13:16:47

删除分组

获取分组内的所有 key