{ "openapi": "3.0.3", "info": { "title": "智谱AI", "description": "智谱AI开放平台连接器，需通过智谱AI开放平台注册购买调用量", "termsOfService": "https://www.showapi.com/helpcenter/view#/4019/2", "version": "1.0.0" }, "servers": [ { "url": "https://route.showapi.com" } ], "paths": { "/3045-7": { "x-pointCode": 7, "x-mode": "mapping", "x-read-timeout": 15, "x-connect-timeout": 10, "post": { "summary": "异步调用结果查询", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "string", "description": "用户在客户端请求时提交的任务编号或者平台生成的任务编号" }, "choices": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string", "description": "当前对话的内容" }, "role": { "type": "string", "description": "当前对话的角色，目前默认为 assistant（模型）" } } }, "description": "当前对话的模型输出内容，目前只返回一条（后续会支持候选模式）" }, "task_status": { "type": "string", "description": "处理状态，PROCESSING（处理中），SUCCESS（成功），FAIL（失败）\n注：处理中状态需通过查询获取结果" }, "task_id": { "type": "string", "description": "智谱AI开放平台生成的任务订单号，调用请求结果接口时请使用此订单号" }, "usage": { "type": "object", "properties": { "total_tokens": { "type": "number", "description": "总 tokens 数量" }, "completion_tokens": { "type": "number", "description": "模型输出的 tokens 数量" }, "prompt_tokens": { "type": "number", "description": "用户输入的 tokens 数量" } }, "description": "本次模型调用的 tokens 数量统计" } } }, "code": { "type": "number", "description": "错误码，详情请查看错误码说明" }, "success": { "type": "boolean", "description": "请求成功失败标识，true（成功），false（失败）" }, "msg": { "type": "string", "description": "错误信息" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "3045_7_POST", "parameters": [ { "name": "task_id", "in": "query", "description": "智谱AI开放平台生成的任务订单号", "required": true, "schema": { "type": "string" } }, { "name": "ds_id", "in": "query", "description": "您在万维易源的智谱数据源id", "required": true, "schema": { "type": "string" } } ] } }, "/3045-6": { "x-pointCode": 6, "x-mode": "mapping", "x-read-timeout": 40, "x-connect-timeout": 40, "post": { "summary": "异步调用ChatGLM-Lite", "description": "适用于对反应速度和成本比较敏感，且任务较为简单的场景，比如聊天、客服、分类、提取等。原文档https://open.bigmodel.cn/dev/api#chatglm_lite", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "string", "description": "用户在客户端请求时提交的任务编号或者平台生成的任务编号" }, "task_status": { "type": "string", "description": "智谱AI开放平台生成的任务订单号，调用请求结果接口时请使用此订单号" }, "task_id": { "type": "string", "description": "处理状态，PROCESSING（处理中），SUCCESS（成功），FAIL（失败）\n注：处理中状态需通过查询获取结果" } } }, "code": { "type": "number", "description": "错误码，详情请查看错误码说明" }, "success": { "type": "boolean", "description": "请求成功失败标识，true（成功），false（失败）" }, "msg": { "type": "string", "description": "错误信息" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "3045_6_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "your_params": { "type": "string", "description": "您的请求参数，一个json字符串，其中字段如下：\nprompt （List类型）必须 调用对话模型时，将当前对话信息列表作为提示输入给模型; 按照 {\"role\": \"user\", \"content\": \"你好\"} 的键值对形式进行传参; 总长度超过模型最长输入限制后会自动截断，需按时间由旧到新排序。\n\ntemperature（float类型）可选 采样温度，控制输出的随机性，必须为正数\n取值范围是：(0.0,1.0]，不能等于 0,默认值为 0.95\n值越大，会使输出更随机，更具创造性；值越小，输出会更加稳定或确定\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n\ntop_p （float类型）可选 用温度取样的另一种方法，称为核取样\n取值范围是：(0.0, 1.0) 开区间，不能等于 0 或 1，默认值为 0.7\n模型考虑具有 top_p 概率质量tokens的结果\n例如：0.1 意味着模型解码器只考虑从前 10% 的概率的候选集中取tokens\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n" }, "ds_id": { "type": "string", "description": "您的数据源id" } }, "required": [ "your_params", "ds_id" ] } } } } } }, "/3045-5": { "x-pointCode": 5, "x-mode": "mapping", "x-read-timeout": 40, "x-connect-timeout": 40, "post": { "summary": "异步调用ChatGLM-Std", "description": "适用于需要兼顾效果和成本的场景，比如新闻写作、企业内部知识库、摘要生成、垂直检索等。原文档：https://open.bigmodel.cn/dev/api#chatglm_std", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "string", "description": "用户在客户端请求时提交的任务编号或者平台生成的任务编号" }, "task_status": { "type": "string", "description": "处理状态，PROCESSING（处理中），SUCCESS（成功），FAIL（失败）\n注：处理中状态需通过查询获取结果" }, "task_id": { "type": "string", "description": "智谱AI开放平台生成的任务订单号，调用请求结果接口时请使用此订单号" } } }, "code": { "type": "number", "description": "错误码，详情请查看错误码说明" }, "success": { "type": "boolean", "description": "请求成功失败标识，true（成功），false（失败）" }, "msg": { "type": "string", "description": "错误信息" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "3045_5_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "your_params": { "type": "string", "description": "您的请求参数，一个json字符串，其中字段如下：\nprompt （List类型）必须 调用对话模型时，将当前对话信息列表作为提示输入给模型; 按照 {\"role\": \"user\", \"content\": \"你好\"} 的键值对形式进行传参; 总长度超过模型最长输入限制后会自动截断，需按时间由旧到新排序。\n\ntemperature（float类型）可选 采样温度，控制输出的随机性，必须为正数\n取值范围是：(0.0,1.0]，不能等于 0,默认值为 0.95\n值越大，会使输出更随机，更具创造性；值越小，输出会更加稳定或确定\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n\ntop_p （float类型）可选 用温度取样的另一种方法，称为核取样\n取值范围是：(0.0, 1.0) 开区间，不能等于 0 或 1，默认值为 0.7\n模型考虑具有 top_p 概率质量tokens的结果\n例如：0.1 意味着模型解码器只考虑从前 10% 的概率的候选集中取tokens\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n" }, "ds_id": { "type": "string", "description": "您的数据源id" } }, "required": [ "your_params", "ds_id" ] } } } } } }, "/3045-4": { "x-pointCode": 4, "x-mode": "mapping", "x-read-timeout": 40, "x-connect-timeout": 40, "post": { "summary": "异步调用ChatGLM-Pro", "description": "适用于对知识量、推理能力、创造力要求较高的场景，比如广告文案、小说写作、知识类写作、代码生成等。原文档https://open.bigmodel.cn/dev/api#chatglm_pro", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "string", "description": "用户在客户端请求时提交的任务编号或者平台生成的任务编号" }, "task_status": { "type": "string", "description": "处理状态，PROCESSING（处理中），SUCCESS（成功），FAIL（失败）\n注：处理中状态需通过查询获取结果" }, "task_id": { "type": "string", "description": "智谱AI开放平台生成的任务订单号，调用请求结果接口时请使用此订单号" } } }, "code": { "type": "number", "description": "错误码，详情请查看错误码说明" }, "success": { "type": "boolean", "description": "请求成功失败标识，true（成功），false（失败）" }, "msg": { "type": "string", "description": "错误信息" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "3045_4_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "your_params": { "type": "string", "description": "您的请求参数，一个json字符串，其中字段如下：\nprompt （List类型）必须 调用对话模型时，将当前对话信息列表作为提示输入给模型; 按照 {\"role\": \"user\", \"content\": \"你好\"} 的键值对形式进行传参; 总长度超过模型最长输入限制后会自动截断，需按时间由旧到新排序。\n\ntemperature（float类型）可选 采样温度，控制输出的随机性，必须为正数\n取值范围是：(0.0,1.0]，不能等于 0,默认值为 0.95\n值越大，会使输出更随机，更具创造性；值越小，输出会更加稳定或确定\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n\ntop_p （float类型）可选 用温度取样的另一种方法，称为核取样\n取值范围是：(0.0, 1.0) 开区间，不能等于 0 或 1，默认值为 0.7\n模型考虑具有 top_p 概率质量tokens的结果\n例如：0.1 意味着模型解码器只考虑从前 10% 的概率的候选集中取tokens\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n" }, "ds_id": { "type": "string", "description": "您的数据源id" } }, "required": [ "your_params", "ds_id" ] } } } } } }, "/3045-3": { "x-pointCode": 3, "x-mode": "mapping", "x-read-timeout": 40, "x-connect-timeout": 40, "post": { "summary": "同步调用ChatGLM-Lite", "description": "适用于对反应速度和成本比较敏感，且任务较为简单的场景，比如聊天、客服、分类、提取等。原文档https://open.bigmodel.cn/dev/api#chatglm_lite", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "string", "description": "平台生成的任务编号" }, "choices": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string", "description": "当前对话的内容" }, "role": { "type": "string", "description": "当前对话的角色，目前默认为 assistant（模型）" } } }, "description": "当前对话的模型输出内容，目前只返回一条（后续会支持候选模式）" }, "task_status": { "type": "string", "description": "处理状态，PROCESSING（处理中），SUCCESS（成功），FAIL（失败） 注：处理中状态需通过查询获取结果" }, "task_id": { "type": "string", "description": "智谱AI开放平台生成的任务订单号，调用请求结果接口时请使用此订单号" }, "usage": { "type": "object", "properties": { "total_tokens": { "type": "number", "description": "总 tokens 数量" } }, "description": "本次模型调用的 tokens 数量统计" } } }, "code": { "type": "number", "description": "200为正常情况，详情查看帮助手册" }, "success": { "type": "boolean", "description": "请求成功失败标识，true（成功），false（失败）" }, "msg": { "type": "string", "description": "\t\n错误信息" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "3045_3_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "your_params": { "type": "string", "description": "您的请求参数，一个json字符串，其中字段如下：\nprompt （List类型）必须 调用对话模型时，将当前对话信息列表作为提示输入给模型; 按照 {\"role\": \"user\", \"content\": \"你好\"} 的键值对形式进行传参; 总长度超过模型最长输入限制后会自动截断，需按时间由旧到新排序。\n\ntemperature（float类型）可选 采样温度，控制输出的随机性，必须为正数\n取值范围是：(0.0,1.0]，不能等于 0,默认值为 0.95\n值越大，会使输出更随机，更具创造性；值越小，输出会更加稳定或确定\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n\ntop_p （float类型）可选 用温度取样的另一种方法，称为核取样\n取值范围是：(0.0, 1.0) 开区间，不能等于 0 或 1，默认值为 0.7\n模型考虑具有 top_p 概率质量tokens的结果\n例如：0.1 意味着模型解码器只考虑从前 10% 的概率的候选集中取tokens\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n" }, "ds_id": { "type": "string", "description": "您的数据源id" } }, "required": [ "your_params", "ds_id" ] } } } } } }, "/3045-2": { "x-pointCode": 2, "x-mode": "mapping", "x-read-timeout": 40, "x-connect-timeout": 40, "post": { "summary": "同步调用ChatGLM-Std", "description": "适用于需要兼顾效果和成本的场景，比如新闻写作、企业内部知识库、摘要生成、垂直检索等。原文档：https://open.bigmodel.cn/dev/api#chatglm_std", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "string", "description": "平台生成的任务编号" }, "choices": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string", "description": "当前对话的内容" }, "role": { "type": "string", "description": "当前对话的角色，目前默认为 assistant（模型）" } } }, "description": "当前对话的模型输出内容，目前只返回一条（后续会支持候选模式）" }, "task_status": { "type": "string", "description": "处理状态，PROCESSING（处理中），SUCCESS（成功），FAIL（失败） 注：处理中状态需通过查询获取结果" }, "task_id": { "type": "string", "description": "智谱AI开放平台生成的任务订单号，调用请求结果接口时请使用此订单号" }, "usage": { "type": "object", "properties": { "total_tokens": { "type": "number", "description": "总 tokens 数量" } }, "description": "本次模型调用的 tokens 数量统计" } } }, "code": { "type": "number", "description": "错误码，详情请查看帮助手册错误码说明" }, "success": { "type": "boolean", "description": "请求成功失败标识，true（成功），false（失败）" }, "msg": { "type": "string", "description": "错误信息" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "3045_2_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "your_params": { "type": "string", "description": "您的请求参数，一个json字符串，其中字段如下：\nprompt （List类型）必须 调用对话模型时，将当前对话信息列表作为提示输入给模型; 按照 {\"role\": \"user\", \"content\": \"你好\"} 的键值对形式进行传参; 总长度超过模型最长输入限制后会自动截断，需按时间由旧到新排序。\n\ntemperature（float类型）可选 采样温度，控制输出的随机性，必须为正数\n取值范围是：(0.0,1.0]，不能等于 0,默认值为 0.95\n值越大，会使输出更随机，更具创造性；值越小，输出会更加稳定或确定\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n\ntop_p （float类型）可选 用温度取样的另一种方法，称为核取样\n取值范围是：(0.0, 1.0) 开区间，不能等于 0 或 1，默认值为 0.7\n模型考虑具有 top_p 概率质量tokens的结果\n例如：0.1 意味着模型解码器只考虑从前 10% 的概率的候选集中取tokens\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n" }, "ds_id": { "type": "string", "description": "您的数据源id" } }, "required": [ "your_params", "ds_id" ] } } } } } }, "/3045-1": { "x-pointCode": 1, "x-mode": "mapping", "x-read-timeout": 40, "x-connect-timeout": 40, "post": { "summary": "同步调用ChatGLM-Pro", "description": "适用于对知识量、推理能力、创造力要求较高的场景，比如广告文案、小说写作、知识类写作、代码生成等。原文档https://open.bigmodel.cn/dev/api#chatglm_pro", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "data": { "type": "object", "properties": { "request_id": { "type": "string", "description": "平台生成的任务编号" }, "choices": { "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string", "description": "当前对话的内容" }, "role": { "type": "string", "description": "当前对话的角色，目前默认为 assistant（模型）" } } }, "description": "当前对话的模型输出内容，目前只返回一条（后续会支持候选模式）" }, "task_status": { "type": "string", "description": "处理状态，PROCESSING（处理中），SUCCESS（成功），FAIL（失败） 注：处理中状态需通过查询获取结果" }, "task_id": { "type": "string", "description": "智谱AI开放平台生成的任务订单号，调用请求结果接口时请使用此订单号" }, "usage": { "type": "object", "properties": { "total_tokens": { "type": "number", "description": "\t\n总 tokens 数量" } }, "description": "\t\n本次模型调用的 tokens 数量统计" } } }, "code": { "type": "number", "description": "错误码，详情请查看帮助手册错误码说明" }, "success": { "type": "boolean", "description": "请求成功失败标识，true（成功），false（失败）" }, "msg": { "type": "string", "description": "错误信息" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "3045_1_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "your_params": { "type": "string", "description": "您的请求参数，一个json字符串，其中字段如下：\nprompt （List类型）必须 调用对话模型时，将当前对话信息列表作为提示输入给模型; 按照 {\"role\": \"user\", \"content\": \"你好\"} 的键值对形式进行传参; 总长度超过模型最长输入限制后会自动截断，需按时间由旧到新排序。\n\ntemperature（float类型）可选 采样温度，控制输出的随机性，必须为正数\n取值范围是：(0.0,1.0]，不能等于 0,默认值为 0.95\n值越大，会使输出更随机，更具创造性；值越小，输出会更加稳定或确定\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n\ntop_p （float类型）可选 用温度取样的另一种方法，称为核取样\n取值范围是：(0.0, 1.0) 开区间，不能等于 0 或 1，默认值为 0.7\n模型考虑具有 top_p 概率质量tokens的结果\n例如：0.1 意味着模型解码器只考虑从前 10% 的概率的候选集中取tokens\n建议您根据应用场景调整 top_p 或 temperature 参数，但不要同时调整两个参数。\n" }, "ds_id": { "type": "string", "description": "您的数据源id" } }, "required": [ "your_params", "ds_id" ] } } } } } } }, "components": { "securitySchemes": { "AppKeyAuth": { "type": "apiKey", "in": "query", "name": "appKey", "description": "从 ShowAPI 控制台获取的 appKey，管理地址：https://www.showapi.com/console#/myApp" } }, "schemas": { "ShowapiResEnvelope": { "type": "object", "description": "ShowAPI 统一返回包裹（业务数据位于 showapi_res_body）", "properties": { "showapi_res_code": { "type": "integer", "description": "API 返回的状态码" }, "showapi_res_error": { "type": "string", "description": "API 返回的错误信息" }, "showapi_res_id": { "type": "string", "description": "API 请求的唯一标识" }, "showapi_fee_num": { "type": "integer", "description": "API 调用计费次数" } } } } }, "security": [ { "AppKeyAuth": [] } ], "externalDocs": { "url": "https://www.showapi.com/apiGateway/view/3045?tab=book" }, "x-apiCode": "3045", "x-is-own": false, "x-is-op": true }