SiteGPT

添加聊天机器人提示

开发环境

POST

/api/v0/chatbots/{chatbotId}/settings/prompts

向聊天机器人添加自定义提示

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://dev-cn.your-api-server.com/api/v0/chatbots//settings/prompts' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "title": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "temperature": "<string>"
}'

响应示例

200 - 成功示例

{
  "success": true,
  "message": "Added a custom prompt to the chatbot successfully",
  "data": {
    "prompt": {
      "id": "c50191ee-85d0-4f46-9448-3ab74441c9fb",
      "title": "Random",
      "description": "Prompt for random replies",
      "instructions": "You are an AI assistant who provides random answers for all the questions asked.",
      "temperature": 0.99
    }
  }
}

请求参数

Path 参数

chatbotId

string

必需

聊天机器人的 ID

Header 参数

Authorization

string

必需

示例值:

Bearer <token>

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

title

string

提示的标题。

必需

description

string

必需

有关提示的简短描述。

instructions

string

必需

生成响应时向 AI 指定的实际指令。

temperature

string

必需

决定聊天机器人响应的创造力水平。 0 更集中，1 更有创意/随机。

示例

返回响应

🟢200成功

application/json

Body

success

boolean

必需

message

string

必需

data

object

必需

prompt

object

必需

🟠400请求有误

🟠401没有权限

🟠403禁止访问

🔴500服务器错误

修改于 2024-03-28 07:53:10

更新消息

删除聊天机器人提示