华为云用户手册

请求示例 { "context_len": 256, "data": [ { "context": { "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328，...] } }, { "context": { "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328，...] } } ] }

响应示例 { "data": [ { "prediction":{ "label": 0 } } ], "time_cost": { "infer_cost_time": "82.609 ms", "postprocess_cost_time": "0.29 ms", "preprocess_cost_time": "0.1332 ms", "service_cost_total_time": "84.965 ms" } }

请求参数 使用Token认证方式的请求Header参数见表2。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。 获取Token 接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表3。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 data 是 Array 参数解释： 时序数据请求的批处理队列。 约束限制： 盘古时序预测分类任务的输入数据内容，用字典承载。输入数据字典中，键对应特征列名，值为序列数据具体内容。 取值范围： 输入数据中的一行数据。 默认取值： 预测大模型在训练完成后，可以在训练日志页面，“模型训练”日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 context_len 否 int 参数解释： 时序任务的数据窗口大小，该参数主要服务于支持多尺度窗口的模型的推理。 约束限制： 填写时需要保证输入序列长度大于等于该值。 取值范围： min:32 max:512 -1为当前服务模型的默认大小。 默认取值： 128

响应示例 { "result": [ { "Box": { "Angle": 0, "Height": 60, "Width": 106, "X": 852, "Y": 182 }, "Score": 0.88427734375, "label": "car" }, { "Box": { "Angle": 0, "Height": 114, "Width": 55, "X": 800, "Y": 170 }, "Score": 0.70556640625, "label": "person" } ] }

响应参数 状态码： 200 表5 响应成功Body参数 参数 参数类型 描述 result Array of objects 识别结果信息。 Score Float 置信度。 label String 检测类别。 Box Dict 检测到的目标主体信息。 表6 Box 参数 参数类型 描述 X Int 矩形框左上角横坐标。 Y Int 矩形框左上角纵坐标。 With Int 矩形框宽度。 Height Int 矩形框高度。 Angle Int 检测到的目标主体区域的角度。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 接口调用成功后将返回如下响应体。 { "id": "180f5745-4ee4-42a9-9869-23f829654bb7", "created": 1724915285, "choices": [ { "index": 0, "text": "故事标题：《穿越宋朝的奇妙之旅》在一个阴雨绵绵的夜晚，一个名叫李晓的年轻人正在阅读一本关于宋朝的历史书籍。突然，他感到一阵眩晕，当他再次睁开眼睛时，他发现自己身处一个完全陌生的地方。李晓发现自己穿越到了宋朝。他身处一座繁华的城市，人们穿着古代的服饰，用着他听不懂的语言交谈。他意识到自己真的穿越了。李晓在宋朝的生活充满了挑战。他必须学习如何使用新的语言，适应新的生活方式。他开始学习宋朝的礼仪，尝试理解这个时代的文化。在宋朝，李晓遇到了许多有趣的人。他遇到了一位名叫赵敏拿来的小女孩，她聪明伶俐，让李晓对她产生了深深的喜爱。他还遇到了一位名叫王安石的大儒，他的智慧和博学让李晓深感敬佩。在宋朝的生活中，李晓也遇到了许多困难。他必须适应新的食物，新的气候，甚至新的疾病。但是，他从未放弃，他始终坚信，只要他坚持下去，他就能适应这个新的世界。在宋朝的生活中，李晓也找到了新的目标。他开始学习宋朝的书法，尝试理解这个时代的艺术。他还开始学习宋朝的医学，尝试理解这个时代的科学。在宋朝的生活中，李晓也找到了新的爱情。他与赵敏拿来建立了深厚的感情，他们的conseillé情深深地打动了李晓。最后，李晓决定留在宋朝。他发现，他已经深深地爱上了这个时代，爱上了这里的人，爱上了这里的食物，爱上了这里的一切。这就是李晓在宋朝的hesion之旅，一个充满挑战和机遇的旅程。虽然他来自未来，但他已经成为了宋朝的一部分，成为了这个时代的一部分。", "ppl": 1.77809815678146e-36 } ], "usage": { "completion_tokens": 365, "prompt_tokens": 9, "total_tokens": 374 } } 当接口调用出错时，会返回错误码及错误信息说明。 token有效期为24小时，下面的报错表示token过期。 { "error_msg": "Incorrect IAM authentication information: token expires, expires_at:2023-06-29T02:16:41.581000Z", "error_code": "APIG.0301", "request_id": "469967f55e6b225xxx" } 其中，error_code表示错误码，error_msg表示错误描述信息。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result List 物体检测的识别结果。 表6 响应Body参数 参数 参数类型 描述 RegisterMatrix List 默认为[[1, 0, 0], [0, 1, 0], [0, 0, 1]]，表示图片特征矩阵。 Label String 预测类别。 Score Float 置信度。 Box Dict 检测到的目标主体信息，格式为{"x":x1,"y":y1,"width":w,"height":h，'Angle':angle}。 x：检测到的目标主体区域的左上角x坐标。 y：检测到的目标主体区域的左上角y坐标。 width：检测到的目标主体区域的宽度。 height：检测到的目标主体区域的高度。 angle: 检测到的目标主体区域的角度。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

响应示例 { "result": [ { "RegisterMatrix": [ [ 1, 0, 0 ], [ 0, 1, 0 ], [ 0, 0, 1 ] ] }, { "Box": { "Y": 0, "Width": 100, "Angle": 0, "X": 0, "Height": 100 }, "Score": 0.9, "label": "person" } ] }

请求示例 { "name" : "demo-task", "input" : { "type" : "obs", "data" : [ { "bucket" : "bucket", "path" : "path/to/directory/" } ] }, "output" : { "obs" : { "bucket" : "bucket", "path" : "path/to/directory/" } }, "config" : { "start_time_begin" : 2017010100, "start_time_end" : 2017010200, "start_time_interval_hours" : 1, "forecast_lead_hours" : 1, "num_ensembles" : 2, "ensemble_noise_method" : "perlin", "ensemble_noise_perlin_scale" : 0.1, "ensemble_noise_perlin_octave" : 1, "ensemble_noise_perlin_x" : 0.2, "ensemble_noise_perlin_y" : 0.2, "draw_figures" : "true" } }

请求参数 使用Token认证方式的请求Header参数见表2。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表3。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 推理作业的名称。 input 是 TaskInputDto object 输入数据的信息。 output 是 TaskOutputDto object 输出数据的信息。 config 是 TaskConfigDto object 科学计算大模型配置信息。 表5 TaskInputDto 参数 是否必选 参数类型 描述 type 是 String 存储类型，取值为obs。 data 是 Array of ObsStorageDto objects 输入数据的OBS信息。 表6 ObsStorageDto 参数 是否必选 参数类型 描述 bucket 是 String 输入数据的OBS桶名称。 path 是 String 初始场数据的存放路径。 表7 TaskOutputDto 参数 是否必选 参数类型 描述 obs 是 ObsStorageDto object 输出数据的OBS信息。 表8 TaskConfigDto 参数 是否必选 参数类型 描述 start_time_begin 是 String 起报时间区间起点（YYYYMMDDHH时间戳）。 start_time_end 是 String 起报时间区间终点（YYYYMMDDHH时间戳）。 start_time_interval_hours 否 Long 起报时间间隔小时数，默认6。取值范围：[1, 24]。 forecast_lead_hours 否 Long 预报未来小时数，默认168，取值范围：[1, 720]。 draw_figures 否 String 是否输出结果图片，取值true/false，默认true。 num_ensembles 否 Long 集合数量。在气象预报中，集合预报是指对初始场加入一定程序的扰动，使其生成一组由不同初始场预报的天气预报结果，从而提供对未来天气状态的概率信息。这种方法可以更好地表达预报的不确定性，从而提高预报的准确性和可靠性。 取值范围：[2, 10]。 ensemble_noise_method 否 String 集合预报的加噪方式。可选：{"perlin"}。 peilin噪音通过对输入数据（比如空间坐标）进行随机扰动，让模拟出的天气接近真实世界中的变化。 ensemble_noise_perlin_scale 否 Double 集合预报的Perlin加噪scale。取值范围：(0, 0.5)。 ensemble_noise_perlin_octave 否 Long 用于选择集合预报的Perlin加噪octave。Perlin噪音的octave指的是噪音的频率，在生成Perlin噪音时，可以将多个不同频率的噪音叠加在一起，以增加噪音的复杂度和细节。每个频率的噪音称为一个octave，而叠加的octave数越多，噪音的复杂度也就越高。 取值范围：[1, 10)。 ensemble_noise_perlin_x 否 Double 用于选择集合预报的Perlin加噪x经度方向的尺度。 取值范围：[0, 1)。 ensemble_noise_perlin_y 否 Double 用于选择集合预报的Perlin加噪y纬度方向的尺度。 取值范围：[0, 1)。 表9 全球中期天气要素预测模型、降水模型信息表 模型 预报层次 预报高空变量 预报表面变量 降水 时间分辨率 水平分辨率 区域范围 全球中期天气要素预测模型 13层（1000hpa, 925hpa, 850hpa, 700hpa, 600hpa, 500hpa, 400hpa, 300hpa, 250hpa, 200hpa, 150hpa, 100hpa, 50hpa） T：温度 Q：比湿 Z：重力位势 U：U风 V：V风 MLSP：海平面气压 U10：10米U风，经度方向 V10：10米V风，纬度方向 T2M：2米温度 - 1、3、6、24小时 0.25°*0.25° 全球 降水基模型 13层（1000hpa, 925hpa, 850hpa, 700hpa, 600hpa, 500hpa, 400hpa, 300hpa, 250hpa, 200hpa, 150hpa, 100hpa, 50hpa） T：温度 Q：比湿 Z：重力位势 U：U风 V：V风 MLSP：海平面气压 U10：10米U风，经度方向 V10：10米V风，纬度方向 T2M：2米温度 PRECIP6：过去6h累计降水 PRECIP24：过去24h累计降水 1、3、6、24小时 0.25°*0.25° 全球

响应示例 非流式 状态码： 200 OK { "id": "chat-9a75fc02e45d48db94f94ce38277beef", "object": "chat.completion", "created": 1743403365, "model": "DeepSeek-V3", "choices": [ { "index": 0, "message": { "role": "assistant", "content": "你好！有什么我可以帮助你的吗？", "tool_calls": [] }, "finish_reason": "stop" } ], "usage": { "prompt_tokens": 64, "total_tokens": 73, "completion_tokens": 9 } } 流式（stream参数为true） 状态码： 200 OK data:{"id":"chat-97313a4bc0a342558364345de0380291","object":"chat.completion.chunk","created":1743404317,"model":"DeepSeek-V3","choices":[{"index":0,"delta":{"role":"assistant"},"logprobs":null,"finish_reason":null}] data:{"id":"chat-97313a4bc0a342558364345de0380291","object":"chat.completion.chunk","created":1743404317,"model":"DeepSeek-V3","choices":[{"index":0,"delta":{"content":"你好"},"logprobs":null,"finish_reason":null}]} data:{"id":"chat-97313a4bc0a342558364345de0380291","object":"chat.completion.chunk","created":1743404317,"model":"DeepSeek-V3","choices":[{"index":0,"delta":{"content":"，有什么我能帮您的吗？"},"logprobs":null,"finish_reason":"stop","stop_reason":null}]} data:[DONE] 流式（stream参数为true，触发 内容审核 ） 状态码： 200 OK event:moderation data:{"suggestion":"block","reply":"作为AI语言模型，我的目标是以积极、正向和安全的方式提供帮助和信息，您的问题超出了我的回答范围。"} data:[DONE]

请求示例 非流式 POST https://{endpoint}/v1/{project_id}/alg-infer/3rdnlp/service/{deployment_id}/v1/chat/completions Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "model":"DeepSeek-V3", "messages":[ { "role":"user", "content":"你好" }] } 流式（stream参数为true） POST https://{endpoint}/v1/{project_id}/alg-infer/3rdnlp/service/{deployment_id}/v1/chat/completions Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "model":"DeepSeek-V3", "messages":[ { "role":"user", "content":"你好" }], "stream":true }

响应参数 非流式 状态码： 200 表8 响应Body参数 参数 参数类型 描述 id String 用来标识每个响应的唯一字符串。形式为："chatcmpl-{random_uuid()}" object String 固定为"chat.completion" created Integer 响应生成的时间，单位：s。 model String 请求模型ID，固定值：pangu。 choices Array of表9 ChatCompletionResponseChoice objects 生成的文本列表。 usage 表10 object 该对话请求的token用量信息。该参数可以帮助用户了解和控制模型的使用情况，避免超出Tokens限制。 prompt_logprobs Object 输入文本以及对应token的对数概率信息。 缺省值：null 表9 ChatCompletionResponseChoice 参数 参数类型 描述 message 表11 object 生成的文本内容。 index Integer 生成的文本在列表中的索引，从0开始。 finish_reason String 模型停止生成 token 的原因。 取值范围：[stop, length, content_filter, tool_calls, insufficient_system_resource] stop：模型自然停止生成，或遇到 stop 序列中列出的字符串。 length ：输出长度达到了模型上下文长度限制，或达到了 max_tokens 的限制。 content_filter：输出内容因触发过滤策略而被过滤。 insufficient_system_resource：系统推理资源不足，生成被打断。 缺省值：stop logprobs Object 评估指标，表示推理输出的置信度。 缺省值：null stop_reason Union[Integer, String] 导致生成停止的token id或者字符串。如果是遇到EOS token则返回默认值。如果是因为用户请求参数参数中指定的stop参数中的字符串或者token id，则返回对应的字符串或者token id。不是openai接口标准字段，但vllm接口支持。 缺省值：None 表10 UsageInfo 参数 参数类型 描述 prompt_tokens Number 用户prompt中所包含的token数。 total_tokens Number 该次对话请求中，所有token的数量。 completion_tokens Number 推理模型所产生的答案的token数量。 表11 ChatMessage 参数 参数类型 描述 role String 生成这条消息的角色。固定为：assistant。 content String 对话的内容。 最小长度：1 最大长度：不同模型支持的token长度。 reasoning_content String 内容为在最终答案之前的推理内容（模型的思考过程）。 说明： 仅适用于 DeepSeek-R1 模型。 流式（stream参数为true） 状态码： 200 表12 流式输出的数据单元 参数 参数类型 描述 data CompletionStreamResponse object stream=true时，模型生成的消息以流式形式返回。生成的内容以增量的方式逐步发送回来，每个data字段均包含一部分生成的内容，直到所有data返回，响应结束。 表13 CompletionStreamResponse 参数 参数类型 描述 id String 该对话的唯一标识符。 created Integer 创建聊天完成时的 Unix 时间戳（以秒为单位）。流式响应的每个 chunk 的时间戳相同。 model String 生成该 completion 的模型名。 object String 对象的类型, 其值为 chat.completion.chunk。 choices ChatCompletionResponseStreamChoice 模型生成的 completion 的选择列表。 表14 ChatCompletionResponseStreamChoice 参数 参数类型 描述 index Integer 该 completion 在模型生成的 completion 的选择列表中的索引。 finish_reason String 模型停止生成 token 的原因。 取值范围：[stop, length, content_filter, tool_calls, insufficient_system_resource]。 stop：模型自然停止生成，或遇到 stop 序列中列出的字符串。 length ：输出长度达到了模型上下文长度限制，或达到了 max_tokens 的限制。 content_filter：输出内容因触发过滤策略而被过滤。 insufficient_system_resource：系统推理资源不足，生成被打断。 状态码： 400 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。

请求参数 使用Token认证方式的请求Header参数见表3。 V1接口支持Token鉴权方式，也支持API Key鉴权方式。 表3 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表 请求Header参数（API Key认证）。 表4 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 V2接口只支持API Key鉴权方式。 表5 V2接口请求Header参数（OpenAI格式的API Key认证） 参数 是否必选 参数类型 描述 Authorization 是 String 用户创建应用接入获取的API Key，拼接“Bearer ”后的字符串。示例：Bearer d59******9C3。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表6 请求Body参数 参数 是否必选 参数类型 描述 messages 是 Array of 表7 objects 多轮对话问答对，包含两个属性：role和content。 role表示对话的角色，取值是system或user。 如果需要模型以某个人设形象回答问题，可以将role参数设置为system。不使用人设时，可设置为user。在一次会话请求中，人设只需要设置一次。 content表示对话的内容，可以是任意文本。 messages参数可以帮助模型根据对话的上下文生成合适的回复。 model 是 String 使用的模型ID，根据所部署的模型填写，填写DeepSeek-R1或DeepSeek-V3。 stream 否 boolean 流式开关。流式输出协议为SSE(Server-Sent Events）协议。 如果开启流式，请赋值true。开启流式开关后，API会在生成文本的过程中，实时地将生成的文本发送给客户端，而不是等到生成完成后一次性将所有文本发送给客户端。 缺省值：false temperature 否 Float 用于控制生成文本的多样性和创造力。 控制采样随机性的浮点数。一般来说，temperature越低，适合完成确定性的任务。temperature越高，如0.9，适合完成创造性的任务。值为 0 意味着贪婪采样。当取值超过1，会大概率出现效果不可用问题。 temperature参数可以影响语言模型输出的质量和多样性，但也不是唯一的因素。还有其他一些参数，如top_p参数也可以用来调整语言模型的行为和偏好，但不建议同时更改这两temperature和top_p。 最小值：0，建议不要低于1e-5 最大值：1.0 缺省值：1.0 top_p 否 Float 核采样参数。作为调节采样温度的替代方案，模型会考虑前 top_p 概率的 token 的结果。0.1 就意味着只有包括在最高 10% 概率中的 token 会被考虑。 建议修改这个值或者更改 temperature，但不建议同时对两者进行修改。 取值范围：（0.0, 1.0] 缺省值：0.8 max_tokens 否 Integer 生成文本的最大输出token数量。 输入的文本加上生成的文本总量不能超过模型所能处理的最大长度。 最小值：1 最大值：8K token。 缺省值：默认部署时，token长度为最大值。 说明： token是指模型处理和生成文本的基本单位。token可以是词或者字符的片段。模型的输入和输出的文本都会被转换成token，然后根据模型的概率分布进行采样或者计算。 presence_penalty 否 Float 用于调整模型对新Token的处理方式。即如果一个Token已经在之前的文本中出现过，那么模型在生成这个Token时会受到一定的惩罚。当presence_penalty的值为正数时，模型会更倾向于生成新的、未出现过的Token，即模型会更倾向于谈论新的话题。 最小值：-2 最大值：2 缺省值：0 （表示该参数未生效）。 frequency_penalty 否 Float 用于调整模型对频繁出现的Token的处理方式。即如果一个Token在训练集中出现的频率较高，那么模型在生成这个Token时会受到一定的惩罚。当frequency_penalty的值为正数时，模型会更倾向于生成出现频率较低的Token，即模型会更倾向于使用不常见的词汇。最小值：-2，最大值：2 最小值：-2 最大值：2 缺省值：0 （表示该参数未生效）。 表7 ChatCompletionMessageParam 参数 是否必选 参数类型 描述 role 是 String 对话的角色，默认取值范围：system、user、assistant、tool、function。支持自定义。 如果需要模型以某个人设形象回答问题，可以将role参数设置为system。不使用人设时，可设置为user。 返回参数时，为固定值：assistant。 在一次会话请求中，人设只需要设置一次。 content 是 String 对话的内容，可以是任意文本，单位token。 设置多轮对话时，message中content个数不能超过20。 最小长度：1 最大长度：不同模型支持的token长度。 缺省值：None

URI NLP推理服务支持使用盘古推理接口（V1推理接口）调用，也支持使用业界通用的OpenAi格式接口（V2推理接口）调用。 V1接口、V2接口的鉴权方式不同，请求体和返回体略有差异。 表1 NLP服务推理接口 API分类 API访问路径（URI） V1推理接口 POST /v1/{project_id}/deployments/{deployment_id}/chat/completions V2推理接口 POST /api/v2/chat/completions 表2 V1推理接口路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方法请参见获取项目ID。 deployment_id 是 String 模型的部署ID，获取方法请参见获取模型部署ID。

请求示例 流式（Header中的stream参数为true） POST https://{endpoint}/v1/{project_id}/agent-run/agents/{agent_id}/conversations/{conversation_id} Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... stream: true Request Body: { "query": "查询A12会议室在9:00到10:00的状态" }

响应示例 data:{"event":"start","createdTime":1735558575017} data:{"event":"message","content":"好的","createdTime":1735558576300} data:{"event":"message","content":"，","createdTime":1735558576301} data:{"event":"message","content":"我将","createdTime":1735558576301} data:{"event":"message","content":"调用","createdTime":1735558576302} data:{"event":"message","content":"query","createdTime":1735558576302} data:{"event":"message","content":"_","createdTime":1735558576302} data:{"event":"message","content":"meeting","createdTime":1735558576302} data:{"event":"message","content":"_","createdTime":1735558576302} data:{"event":"message","content":"room","createdTime":1735558576303} data:{"event":"message","content":"_status","createdTime":1735558576303} data:{"event":"message","content":"工具","createdTime":1735558576303} data:{"event":"message","content":"来","createdTime":1735558576304} data:{"event":"message","content":"查询","createdTime":1735558576304} data:{"event":"message","content":"A","createdTime":1735558576304} data:{"event":"message","content":"12","createdTime":1735558576304} data:{"event":"message","content":"会议室","createdTime":1735558576305} data:{"event":"message","content":"在","createdTime":1735558576305} data:{"event":"message","content":"9","createdTime":1735558576305} data:{"event":"message","content":":00","createdTime":1735558576305} data:{"event":"message","content":"到","createdTime":1735558576306} data:{"event":"message","content":"10","createdTime":1735558576306} data:{"event":"message","content":":00","createdTime":1735558576306} data:{"event":"message","content":"的状态","createdTime":1735558576306} data:{"event":"message","content":"。","createdTime":1735558576306} data:{"event":"message","content":"请","createdTime":1735558576307} data:{"event":"message","content":"稍","createdTime":1735558576307} data:{"event":"message","content":"等","createdTime":1735558576307} data:{"event":"message","content":"。","createdTime":1735558576307} data:{"event":"message","content":" ","createdTime":1735558576307} data:{"event":"message","content":" query","createdTime":1735558576307} data:{"event":"message","content":"_","createdTime":1735558576308} data:{"event":"message","content":"meeting","createdTime":1735558576308} data:{"event":"message","content":"_","createdTime":1735558576308} data:{"event":"message","content":"room","createdTime":1735558576308} data:{"event":"message","content":"_status","createdTime":1735558576308} data:{"event":"message","content":"|","createdTime":1735558576308} data:{"event":"message","content":"{\"","createdTime":1735558576309} data:{"event":"message","content":"meeting","createdTime":1735558576309} data:{"event":"message","content":"Room","createdTime":1735558576309} data:{"event":"message","content":"\":","createdTime":1735558576309} data:{"event":"message","content":"{\"","createdTime":1735558576309} data:{"event":"message","content":"number","createdTime":1735558576310} data:{"event":"message","content":"\":","createdTime":1735558576310} data:{"event":"message","content":" 12","createdTime":1735558576310} data:{"event":"message","content":"}","createdTime":1735558576310} data:{"event":"message","content":",\"","createdTime":1735558576310} data:{"event":"message","content":"start","createdTime":1735558576310} data:{"event":"message","content":"\":\"","createdTime":1735558576311} data:{"event":"message","content":"9","createdTime":1735558576311} data:{"event":"message","content":":00","createdTime":1735558576311} data:{"event":"message","content":"\",\"","createdTime":1735558576311} data:{"event":"message","content":"end","createdTime":1735558576311} data:{"event":"message","content":"\":\"","createdTime":1735558576311} data:{"event":"message","content":"10","createdTime":1735558576311} data:{"event":"message","content":":00","createdTime":1735558576312} data:{"event":"message","content":"\"}","createdTime":1735558576312} data:{"event":"message","content":" ","createdTime":1735558576312} data:{"event":"plugin_start","type":"plugin","latency":{"overall":1.3},"plugin":{"name":"query_meeting_room_status","arguments":"{\"meetingRoom\": {\"number\": 12}, \"start\": \"9:00\", \"end\": \"10:00\"}"},"createdTime":1735558576316} data:{"event":"plugin_end","content":{"result":"空闲"},"role":"function","latency":{"overall":1.51,"plugin":0.0},"createdTime":1735558576521} data:{"event":"start","createdTime":1735558576522} data:{"event":"message","content":"A","createdTime":1735558576976} data:{"event":"message","content":"12","createdTime":1735558576977} data:{"event":"message","content":"会议室","createdTime":1735558576977} data:{"event":"message","content":"在","createdTime":1735558576977} data:{"event":"message","content":"9","createdTime":1735558576978} data:{"event":"message","content":":00","createdTime":1735558576978} data:{"event":"message","content":"到","createdTime":1735558576978} data:{"event":"message","content":"10","createdTime":1735558576978} data:{"event":"message","content":":00","createdTime":1735558576978} data:{"event":"message","content":"的时间","createdTime":1735558576978} data:{"event":"message","content":"段","createdTime":1735558576979} data:{"event":"message","content":"内","createdTime":1735558576979} data:{"event":"message","content":"是","createdTime":1735558576979} data:{"event":"message","content":"空闲","createdTime":1735558576979} data:{"event":"message","content":"的","createdTime":1735558576979} data:{"event":"message","content":"。","createdTime":1735558576980} data:{"event":"statistic_data","latency":{"overall":1.97},"createdTime":1735558576986} data:{"event":"summary_response","content":"A12会议室在9:00到10:00的时间段内是空闲的。","role":"assistant","createdTime":1735558576987} data:{"event":"done","createdTime":1735558577011}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 stream 是 Boolean 是否开启流式调用，默认开启。 true：开启 false：不开启 说明： 当前Agent只支持流式调用，需设置为true。 表3 请求Body参数 参数 是否必选 参数类型 描述 query 是 String 用户问题，作为运行Agent的输入。

响应参数 流式（Header中的stream参数为true） 状态码： 200 表4 流式输出的数据单元 参数 参数类型 描述 data String stream=true时，执行Agent的消息以流式形式返回。 生成的内容以增量的方式逐步发送回来，每个data字段均包含一部分生成的内容，直到所有data返回，响应结束。 表5 流式输出的数据单元 参数 参数类型 描述 event String 数据单元类型，有以下几种类型： start，开始节点，表示开始调用模型进行会话。 message，消息节点，表示模型返回的消息。 plugin_start，插件调用请求节点，表示调用插件的请求信息。 plugin_end，插件调用响应节点，表示调用插件的响应信息。 statistic_data，执行数据节点，包含本次调用的耗时信息。 summary_response，消息总结节点，包含本次调用的全量响应信息。 done，流式调用结束节点，表示流式响应结束。 content Object 消息块内容，不同event的消息块内容不同。 createdTime long 消息块返回的时间戳，如1733817348963。 latency Object 耗时，包括以下三个元素： plugin，插件调用耗时 model，模型调用耗时 overall，总耗时 plugin Object 插件请求信息，包括以下两个元素： name，插件名 arguments，插件入参名

响应示例 非流式（Header中的stream参数为false） 输入节点返回： { "conversation_id": "2c90493f-803d-431d-a197-57543d414317", "messages": [ { "role": "assistant", "content": "{\"inputs\": [{\"actualType\": \"string\", \"sourceType\": \"null\", \"description\": \"姓名\", \"name\": \"name\", \"type\": \"string\", \"required\": true}]}", "nodeId": "node_1745928389632", "nodeType": "Input", "nodeName": "输入" } ], "status": { "code": 3, "desc": "waiting" }, "start_time": 1734336269313, "end_time": 1734336270908 } 提问器节点返回： { "conversation_id": "f9a5540f-0c92-4f28-bd6e-f96ce04f5cc81", "messages": [ { "role": "assistant", "content": "请您提供姓名, 年龄相关的信息", "nodeId": "node_1745929628452", "nodeType": "Questioner", "nodeName": "提问器" } ], "status": { "code": 3, "desc": "waiting" }, "start_time": 1745929778250, "end_time": 1745929779951 } 结束节点返回： { "conversation_id": "2c90493f-803d-431d-a197-57543d414317", "outputs": { "responseContent": "你好！有什么我可以帮助你的吗？" }, "messages": [], "status": { "code": 1, "desc": "succeeded" }, "start_time": 1734337068533, "end_time": 1734337082545 } 流式（Header中的stream参数为true或不传） 输入节点返回： data:{"event":"workflow_started","data":{"start_time":1745929087614}} data:{"event":"message","data":{"text":"{\"inputs\": [{\"actualType\": \"string\", \"sourceType\": \"null\", \"description\": \"姓名\", \"name\": \"name\", \"type\": \"string\", \"required\": true}]}","index":0,"node_id":"node_1745928389632","node_type":"Input","node_name":"输入"}} data:{"event":"message","data":{"text":"","node_id":"node_1745928389632","node_type":"Input","node_name":"输入","is_finished":true}} data:{"event":"end"} 提问器节点返回： data:{"event":"workflow_started","data":{"start_time":1745929709955}} data:{"event":"message","data":{"text":"请您提供姓名, 年龄相关的信息","index":0,"node_id":"node_1745929628452","node_type":"Questioner","node_name":"提问器"}} data:{"event":"message","data":{"text":"","node_id":"node_1745929628452","node_type":"Questioner","node_name":"提问器","is_finished":true}} data:{"event":"end"} 结束节点返回： data:{"event":"workflow_started","data":{"start_time":1745929897770}} data:{"event":"message","data":{"text":"","index":0,"node_id":"node_end","node_type":"End","node_name":"结束"}} data:{"event":"message","data":{"text":"你好","index":1,"node_id":"node_end","node_type":"End","node_name":"结束"}} data:{"event":"message","data":{"text":"！","index":2,"node_id":"node_end","node_type":"End","node_name":"结束"}} data:{"event":"message","data":{"text":"有什么我可以帮助你的吗？","index":3,"node_id":"node_end","node_type":"End","node_name":"结束"}} data:{"event":"message","data":{"text":"","node_id":"node_end","node_type":"End","node_name":"结束","is_finished":true}} data:{"event":"workflow_finished","data":{"status":{"code":1,"desc":"succeeded"},"outputs":{"responseContent":"你好！有什么我可以帮助你的吗？"},"start_time":1745929897770,"end_time":1745929898600}} data:{"event":"end"}

请求示例 POST https://{endpoint}/v1/{project_id}/agent-run/workflows/{workflow_id}/conversations/{conversation_id} Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... stream: true Request Body: { "inputs": { "query": "你好" }, "plugin_configs": [ { "plugin_id": "xxxxxxxxx", "config": { "key": "value" } } ] }

请求URI 请求URI由如下部分组成： {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 表1 请求URI 参数 说明 URI-scheme 传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 承载REST服务端点的服务器 域名 或IP。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取。 query-string 查询参数，可选，查询参数前面需要带一个“？”，形式为“参数名=参数取值”。 获取请求URI的步骤详见请求URI，示例如下： https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/completions

请求方法 HTTP请求方法，表示服务正在请求操作类型，包括： GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在接口的URI部分，请求方法为“POST”，例如： POST https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/completions

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如，定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 以下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token请参考认证鉴权中的“Token认证”。 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。AK/SK认证的详细说明请参见：AK/SK。 添加消息头后的请求如下所示： POST https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/completions Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINOD...

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 将消息体加入后的请求如下所示，详细参数解释可参考文档API章节。 POST https://{endpoint}/v1/{project_id}/deployments/{deployment_id}/chat/completions Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINOD... { "messages": [ { "content": "介绍下长江，以及长江中典型的鱼类" } ], "temperature": 0.9, "max_tokens": 600 } 综上，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于接口，您可以从响应消息部分看到返回参数及参数说明。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result Object 预测结果信息。 pred_proba Array 预测结果对应的置信度，每条结果为一个Dict，Dict的键值对分别表示预测结果、置信度。 说明：请求字段predict_proba配置为true时，响应body才返回pred_proba子项，否则无该子项。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息

请求示例 { "data": [ { "feature_1": xx, "feature_2": xx, ... "feature_n": xx }, ... { "feature_1": xx, "feature_2": xx, ... "feature_n": xx } ]， "predict_proba": true }

响应示例 { "result": [ "0", "1", ... "0" ], "pred_proba": [ { “0”: 0.791, “1”: 0.209 }, { “0”: 0.103, “1”: 0.897 }, ... { “0”: 0.665, “1”: 0.335 }, ] }

请求参数 使用Token认证方式的请求Header参数见表2。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表3。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 data 是 Array 参数解释： 待进行预测的数据，data为一个数组，数组中包含多个对象，每个对象是一组完整的特征数据。 约束限制： 待预测特征名需要与训练数据中的特征名保持一致。例如，训练数据中特征列按照feature_1、feature_2……进行命名，在调用推理接口时，特征名也需要保持相同。同时推理接口中特征数量需要与训练数据中的特征数保持一致。一组特征数据填写完成后再填写剩余待预测数据，格式详见请求示例。 取值范围： 输入数据中的一组数据。 默认取值： 预测大模型在训练完成后，可以在训练日志页面，“模型训练”日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 predict_proba 否 boolean 参数解释： 是否输出置信度 约束限制： 无 取值范围： true或false 默认取值： 非必填项，默认false。

请求参数 使用Token认证方式的请求Header参数见表2。 表2 请求Header参数（Token认证） 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 使用API Key认证方式的请求Header参数见表3。 表3 请求Header参数（API Key认证） 参数 是否必选 参数类型 描述 X-Apig-AppCode 是 String API Key值。 用于获取操作API的权限。API Key认证响应消息头中X-Apig-AppCode的值即为API Key。 Content-Type 是 String 发送的实体的MIME类型，参数值为“application/json”。 表4 请求Body参数 参数 是否必选 参数类型 描述 data 是 Array 参数解释： 时序数据请求的批处理队列。 约束限制： 盘古时序预测回归任务的输入数据内容，用字典承载。输入数据字典中，键对应特征列名，值为序列数据具体内容。 取值范围： 输入数据中的一组数据。 默认取值： 预测大模型在训练完成后，可以在训练日志页面，“模型训练”日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 context_len 否 int 参数解释： 时序任务的数据窗口大小，该参数主要服务于支持多尺度窗口的模型的推理。 约束限制： 填写时需要保证输入序列长度大于等于该值。 取值范围： min:32 max:512 -1为当前服务模型的默认大小。 默认取值： 128 prediction_len 否 int 参数解释： 时序预测输出的窗口长度。数值越大输出预测的时间范围越大，但相应的显存占用会增加以及模型预测精度可能会下降。 约束限制： 注若基于已发布模型的进行增量微调，输出窗口需要与其保持一致。 取值范围： 建议取值范围48至96，且尽量选择预测目标周期的整数倍 默认取值： 96