创建Prompt模板标签
更新时间:2024-12-23
接口描述
本接口用于新建Prompt模板标签。
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/promptLabels?Action=CreatePromptLabel HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"name": [
"myLabel1",
"myLabel2"
]
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,本接口为CreatePromptLabel |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
name | array[string] | 是 | 标签名称列表,最少1个,最多支持10个 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
code | string | 错误码,错误时返回 |
message | string | 错误信息,请求失败时返回 |
result | object | 请求结果,请求成功时返回 |
result说明
名称 | 类型 | 描述 |
---|---|---|
labels | array[object] | 创建成功的标签对象列表 |
labels说明
名称 | 类型 | 描述 |
---|---|---|
labelName | string | 标签名称 |
labelId | string | 标签ID |
请求示例
# 替换下列示例中的Authorization、x-bce-date
curl -i --location 'https://qianfan.baidubce.com/v2/promptLabels?Action=CreatePromptLabel'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44axxxx4525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"name": [
"myLabel1",
"myLabel2"
]
}'
响应示例
{
"requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"labels": [
{
"labelName": "myLabel1",
"labelId": "pl-8ab11516ca2f4d02"
},
{
"labelName": "myLabel1",
"labelId": "pl-cab11516ca2f4dsf"
}
]
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。