Chat对话API 本文是关于Chat 对话API的详情描述。 接口描述 描述 接口名称 对话 请求路径 功能描述 针对描述会话的消息列表,模型将返回响应 请求参数 请求头参数 参数 示例值 描述 Authorization Bearer AppKey 鉴权信息填入AppKey。 ContentType application/json 请求参数 说明: 此参数为全平台模型通用,每个模型支持的参数、参数范围可能因模型不同而有所差异,详细可见模型的API文档。 参数名称 二级参数 三级参数 四级参数 类型 必选 描述 model string 是 模型ID。 messages array 是 用户当前输入的期望模型执行指令。一个列表内多个字典,支持多轮对话。 对话列表,每个列表项为一个message object,message object中包含用户role和content两部分信息: role可选值为user、assistant、system; role为system时,不校验content空值,且message中system只能位于开头,即messages[0]位置; role为user时说明是用户提问,role为assistant时说明是模型回答,而content为实际的对话内容; 单轮/多轮对话中,最后一个message中role必须为user,content为用户输入的最新问题,其余结果除system角色外都为历史信息拼接送入 messages中,assistant和user的role只能交替出现,assistant后只能跟user,user后只能跟assistant。 role string 否 对话角色,role类型枚举值:user、assistant、system。 content string/array 是 对话内容,内容目前有两种格式:string,array。 string类型:表示文本对话内容。 array类型:表示多个对话内容列表,每个列表项为一个content object,每个content object包含type、imageurl、text等信息。 type可选值为text、imageurl。 type为text时,取text字段作为对话内容。 type为imageurl时,取imageurl字段作为对话内容。 type string 否 对话内容类型,type类型枚举值: text,imageurl。 text string 否 文本对话内容,type为text时传入。 imageurl object 否 图片对话内容,type为imageurl时传入。 url string 否 图片对话内容中的图片地址,目前可以为二进制数据的base64编码。 frequencypenalty float 否 频率惩罚。它影响模型如何根据文本中词汇token的现有频率惩罚新词汇token。值大于0,会根据新标记在文本中的现有频率来惩罚新标记,从而降低模型逐字重复同一行的可能性。 一般取值范围[2, 2],具体取值范围、默认值需见对应模型。 maxtokens int 否 最大生成长度。控制最大生成长度,超过该值则截断。 一般取值范围(0, 2048],具体取值范围、默认值需见对应模型。 n int 否 1n个choices。 presencepenalty float 否 存在惩罚。用户控制模型生成时整个序列中的重复度。 一般取值范围[2.0, 2.0],具体取值范围、默认值需见对应模型。 responseformat object 否 返回格式。 type string 否 返回格式枚举值:text,jsonobject。 seed int 否 随机种子。用于指定推理过程的随机种子,相同的seed值可以确保推理结果的可重现性,不同的seed值会提升推理结果的随机性。 一般取值范围(0, 9223372036854775807],具体取值范围、默认值需见对应模型。 stop string/array 否 生成停止标识。当模型生成结果以stop中某个元素结尾时,停止文本生成。 stream bool 否 是否以流式接口的形式返回数据。默认为False,非流式。 streamoptions object 否 流式选项,stream为True有效。 includeusage bool 否 是否在返回中包含usage,stream为True有效。 取值为True时,会在流式返回的最后一个chunk里返回usage信息,并该chunk中choices列表为空。 temperature float 否 温度采样。该值越高生成文本的多样性越高,该值越低生成文本的确定性越高。 一般取值范围(0, 2),具体取值范围、默认值需见对应模型。 topk int 否 topk 采样。取值越大,生成的随机性越高;取值越小,生成的确定性越高。 一般取值范围[1, 100],具体取值范围、默认值需见对应模型。 topp float 否 topp 采样。该值越高生成文本的多样性越高,该值越低生成文本的确定性越高。该值为 0 时没有随机性。 一般取值范围(0, 1],具体取值范围、默认值需见对应模型 user string 否 用户唯一身份ID。