数据类型
更新时间：2024-12-24
数据类型如下。
message说明
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| role | string | 是 | 当前支持以下： · user: 表示用户 · assistant: 表示对话助手 · system：表示人设 |
| name | string | 否 | message名 |
| content | string | 是 | 对话内容，说明： （1）不能为空 （2）最后一个message对应的content不能为blank字符，如空格、"\n"、“\r”、“\f”等 |
| tool_calls | List[ToolCall] | 否 | 函数调用，function call场景下第一轮对话的返回，第二轮对话作为历史信息在message中传入 |
| tool_call_id | string | 否 | 说明： （1）当role=tool时，该字段必填 （2）模型生成的function call id，对应tool_calls中的tool_calls[].id （3）调用方应该传递真实的、由模型生成id，否则效果有损 |
stream_options说明
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| include_usage | bool | 否 | 流式响应是否输出usage，说明： · true：是，设置为true时，在最后一个chunk会输出一个字段，这个chunk上的usage字段显示整个请求的token统计信息 · false：否，流式响应默认不输出usage |
Tool说明
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| type | string | 是 | 工具类型，取值function |
| function | function | 是 | 函数说明 |
Tool中function说明
Tool中function说明如下
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| name | string | 是 | 函数名 |
| description | string | 否 | 函数描述 |
| parameters | object | 否 | 函数请求参数，JSON Schema 格式，参考JSON Schema描述 |
tool_choice说明
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| type | string | 是 | 指定工具类型，固定值function |
| function | function | 是 | 指定要使用的函数 |
tool_choice中function说明
tool_choice中function说明如下
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| name | string | 是 | 指定要使用的函数名 |
web_search说明
| 名称 | 类型 | 描述 |
|---|---|---|
| enable | bool | 是否开启实时搜索功能，说明： （1）如果关闭实时搜索，角标和溯源信息都不会返回 （2）可选值： · true：开启 · false：关闭，默认false |
| enable_citation | bool | 是否开启上角标返回，说明： （1）enable为true时生效 （2）可选值： · true：开启；如果开启，在触发了搜索增强的场景下，响应内容会附上角标，并带上角标对应的搜索溯源信息 · false：未开启，默认false （3）如果检索内容包含非公开网页，角标不生效 |
| enable_trace | bool | 是否返回搜索溯源信息，说明： （1）enable 为 true时生效。 （2）可选值： · true：返回；如果为true，在触发了搜索增强的场景下，会返回搜索溯源信息search_results · false：不返回，默认false （3）如果检索内容为非公开网页，即使触发搜索也不返回溯源信息 |
response_format说明
| 名称 | 类型 | 描述 |
|---|---|---|
| type | string | 指定响应内容的格式，可选值： · json_object：以json格式返回，可能出现不满足效果情况 · text：以文本格式返回，默认为text · json_schema：以json_scheam规定的格式返回 |
| json_schema | object | json_schema格式，请参考JSON Schema描述；当type为json_schema时，该参数必填 |
choices说明
当stream=false时，返回内容如下：
| 名称 | 类型 | 描述 |
|---|---|---|
| index | int | choice列表中的序号 |
| message | message | 响应信息，当stream=false时返回 |
| finish_reason | string | 输出内容标识，说明： · normal：输出内容完全由大模型生成，未触发截断、替换 · stop：输出结果命中入参stop中指定的字段后被截断 · length：达到了最大的token数 · content_filter：输出内容被截断、兜底、替换为**等 · tool_calls：函数调用 |
| flag | int | 安全细分类型，说明： 当stream=false，flag值含义如下： · 0或不返回：安全 · 1：低危不安全场景，可以继续对话 · 2：禁聊：不允许继续对话，但是可以展示内容 · 3：禁止上屏：不允许继续对话且不能上屏展示 · 4：撤屏 |
| ban_round | int | 当flag 不为 0 时，该字段会告知第几轮对话有敏感信息；如果是当前问题，ban_round = -1 |
sse_choices说明
当stream=true时，返回内容如下：
| 名称 | 类型 | 描述 |
|---|---|---|
| index | int | choice列表中的序号 |
| delta | delta | 响应信息，当stream=true时返回 |
| finish_reason | string | 输出内容标识，说明： · normal：输出内容完全由大模型生成，未触发截断、替换 · stop：输出结果命中入参stop中指定的字段后被截断· length：达到了最大的token数 · content_filter：输出内容被截断、兜底、替换为**等 · tool_calls：函数调用 |
| flag | int | 安全细分类型，说明：当stream=true时，返回flag表示触发安全 |
| ban_round | int | 当flag 不为 0 时，该字段会告知第几轮对话有敏感信息；如果是当前问题，ban_round = -1 |
delta说明
| 名称 | 类型 | 描述 |
|---|---|---|
| content | string | 流式响应内容 |
| tool_calls | List[ToolCall] | 由模型生成的函数调用，包含函数名称，和调用参数 |
ToolCall说明
| 名称 | 类型 | 描述 |
|---|---|---|
| id | string | function call的唯一标识，由模型生成 |
| type | string | 固定值function |
| function | function | function call的具体内容 |
ToolCall中function说明
| 名称 | 类型 | 描述 |
|---|---|---|
| name | string | 函数名称 |
| arguments | string | 函数参数 |
usage说明
| 名称 | 类型 | 描述 |
|---|---|---|
| prompt_tokens | int | 问题tokens数（包含历史QA） |
| prompt_tokens_details | int | 问题token详情 |
| completion_tokens | int | 回答tokens数 |
| total_tokens | int | 总tokens数 |
prompt_tokens_details说明
| 名称 | 类型 | 描述 |
|---|---|---|
| search_tokens | int | 触发检索增强以后膨胀的token；用户可以通过usage.prompt_tokens_details.search_tokens>0判断是否出发了检索增强，并且计算出发检索增强的次数 |
search_results说明
| 名称 | 类型 | 描述 |
|---|---|---|
| index | int | 序号 |
| url | string | 搜索结果URL |
| title | string | 搜索结果标题 |