创建会话消息

请求参数

Query 参数

apiKey

string

必需

接口请求凭证(apiKey)。应用助手集成配置页面获取

Body 参数application/json

content

string

提问内容

必需

如果content中涉及到代码等敏感数据，需要将content进行base64后传输

return_format

string

返回内容格式

可选

默认text

search

boolean

是否开启搜索引擎

可选

默认否

visitorId

string

访问者ID

可选

提问用户的唯一ID，如果开启了支持上下文内容选项（在应用助手设置中）, 则需要传递对话用户的唯一ID，以便AI模型区分是哪个用户的提问内容

chatMode

string

对话模型

可选

只有对话助手时才会生效，对话助手支持多个语言模型，可以从查询对话助手可用"对话模型列表"接口中获取，如果不传则默认使用GPT免费版本

intention

array[string]

意图

可选

通过获取意图列表获取意图id

max_tokens

string

最大token

可选

knowledge

string

知识id

可选

通过获取知识库列表接口获取，对话助手无需填写

system

string

对话背景设置

可选

tools

array[string]

工具

可选

通过获取工具列表接口获取，知识助手与对话助手无需填写

temperature

string

创意度

可选

fielditem

object

补充额外联系人信息

可选

当接口自动新建外部联系人时，将自动补充对应信息

handler_type

string

知识助手处理方式

可选

custom-使用自身知识回答;fix-回复固定内容;web_search-使用搜索引擎后回答

fix_content

string

知识助手选择回复固定内容输入的回复内容

可选

stream

boolean

是否以流的形式返回

可选

默认false

ibotID

string

助手id

可选

可使用<查询助手列表>接口获取

示例

{
    "content": "string",
    "return_format": "string",
    "search": true,
    "visitorId": "string",
    "chatMode": "string",
    "intention": [
        "string"
    ],
    "max_tokens": "string",
    "knowledge": "string",
    "system": "string",
    "tools": [
        "string"
    ],
    "temperature": "string",
    "fielditem": {},
    "handler_type": "string",
    "fix_content": "string",
    "stream": true,
    "ibotID": "string"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://chat.jijyun.cn/v1/openapi/chat?apiKey=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "content": "string",
    "return_format": "string",
    "search": true,
    "visitorId": "string",
    "chatMode": "string",
    "intention": [
        "string"
    ],
    "max_tokens": "string",
    "knowledge": "string",
    "system": "string",
    "tools": [
        "string"
    ],
    "temperature": "string",
    "fielditem": {},
    "handler_type": "string",
    "fix_content": "string",
    "stream": true,
    "ibotID": "string"
}'

返回响应

🟢200成功

application/json

Body

desc

string

回答内容

必需

usage

object

必需

total_cost

number

消耗总费用

必需

msgKey

string

会话ID

必需

source

array [object {3}]

搜索来源

可选

link

string

搜索链接

必需

snippet

string

简介

必需

title

string

标题

必需

visitorId

string

访问者ID

必需

示例

{
    "desc": "根据提供的搜索结果，今天的日期是2023年8月16日[1]。",
    "msgKey": "api_93527fda-6b49-4701-b688-6b9ac2346147",
    "source": [
        {
            "link": "https://wannianli.tianqi.com/today",
            "snippet": "今天是<b>2023年8月13日 星期日</b> 第34周. 今天是农历2023年7月27日 六月廿七. 2023年. 8月. 本年查询. 本月节日表. 万年历首页. 第几周. 08月14日 - 08月20日.",
            "title": "【<b>今天</b>是农历几月几日】<b>今天</b>是什么日子_<b>今天</b>农历多少 ..."
        },
        {
            "link": "https://zhidao.baidu.com/question/201223789760702205.html",
            "snippet": "“写信告诉我今天海是什么颜色”，出自歌曲：《听海》； 演唱：张惠妹 写信告诉我今天 海是什么颜色 夜夜陪着你的海 心情又如何 灰色是不想说 蓝色是忧郁 而漂泊的你 狂浪的心 停在哪里 写信告诉我今夜",
            "title": "请问。歌词”写信<b>告诉我</b>，<b>今天</b>海是什么颜色”，这是哪首歌曲 ..."
        },
        {
            "link": "https://zhuanlan.zhihu.com/p/385596882",
            "snippet": "要在Excel 中输入<b>今天的日期</b>，请使用TODAY 函数。 要输入当前<b>日期</b>和时间，请使用 NOW 功能。 要将当前<b>日期</b>和时间作为静态值输入，请使用键盘快捷键。",
            "title": "Excel<b>日期</b>和时间-<b>TODAY</b> 函数获取<b>今天的日期</b> - 知乎"
        }
    ],
    "usage": {
        "total_cost": 0.001
    },
    "visitorId": null
}

🟠401没有权限

🟠402API请求次数不足