ChatWithDesensitize - 脱敏聊天API - 数据管理 DMS

带有DMS脱敏能力的聊天API接口

接口说明

带有 DMS 脱敏能力的聊天 API 接口

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dms:ChatWithDesensitize	none	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	long	是	实例 ID，通过实例 ID 指定对应的脱敏规则。可通过调用接口 ListInstances 或 GetInstance 获取该参数的值。	123***
Messages	array	否	传递给大模型的上下文，按对话顺序排列。
	any	否	对话的每个消息体，标准格式如下： { "content": "$消息内容", "role": "$消息角色：system，user，assistant" }	{ "content": "你好", "role": "user" }
Model	string	否	模型名称。支持的模型：Qwen 系列的纯文本大语言模型（商业版、开源版）。不支持多模态模型	qwen-plus
Stop	array	否	停止词列表。
	string	否	停止词：当模型生成的文本中出现 stop 指定的字符串，生成将立即终止。	\n
NeedDesensitization	boolean	否	是否需要进行脱敏，默认为 false	false
DesensitizationRule	string	否	脱敏类别，needDesensitization 为 true 时不可为空	UserInfo
MaxTokens	integer	否	用于限制模型输出的最大 Token 数。若生成内容超过此值，生成将提前停止。适用于需控制输出长度的场景。	256
PresencePenalty	string	否	控制模型生成文本时的内容重复度。取值范围：[-2.0, 2.0]。正值降低重复度，负值增加重复度。	0.0
ResponseFormat	string	否	返回内容的格式。可选值：text：输出文字回复；json_object：输出标准格式的 JSON 字符串。	text
Seed	integer	否	随机数种子。用于确保在相同输入和参数下生成结果可复现。取值范围：[0, 2^31−1]。	1
EnableThinking	boolean	否	使用混合思考模型时，是否开启思考模式。	true
ThinkingBudget	integer	否	思考过程的最大 token 数	256
Temperature	string	否	采样温度，控制模型生成文本的多样性。temperature 越高，生成的文本更多样，反之，生成的文本更确定。取值范围： [0, 2)	1
TopLogprobs	integer	否	指定在每一步生成时，返回模型最大概率的候选 Token 个数。取值范围：[0, 5]。	1
TopK	integer	否	指定生成过程中用于采样的候选 Token 数量。值越大，输出越随机；值越小，输出越确定。若设为 null 或大于 100，则禁用。	10
TopP	string	否	核采样的概率阈值，控制模型生成文本的多样性。top_p 越高，生成的文本更多样。取值范围：（0,1.0]。	0.5
XDashScopeDataInspection	string	否	在千问 API 的内容安全能力基础上，是否进一步识别输入输出内容的违规信息。	{}
SearchOptions	object	否	联网搜索的策略。
	string	否	联网搜索的策略键值对	{}
ModalitiesList	array	否	输出数据的模态，仅适用于 Qwen-Omni 模型。
	string	否	输出数据的模态	text
AudioJson	string	否	输出音频的音色与格式，仅适用于 Qwen-Omni 模型，且 modalities 参数需为["text","audio"]。	{}
EnableCodeInterpreter	boolean	否	是否开启代码解释器功能。仅当 model 为 qwen3-max-preview 且 enable_thinking 为 true 时生效。	false
Logprobs	boolean	否	是否返回输出 Token 的对数概率，	false
VlHighResolutionImages	boolean	否	是否将输入图像的像素上限提升至 16384 Token 对应的像素值。	false
EnableSearch	boolean	否	是否开启联网搜索。	false

返回参数

名称	类型	描述	示例值
	object	返回内容
RequestId	string	Id of the request	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	错误码。	UnknownError
ErrorMessage	string	错误信息。	UnknownError
Success	boolean	请求是否成功，返回值如下： true：请求成功 false：请求失败	true
Data	object	返回的数据信息。
Created	string	请求创建时的 Unix 时间戳（秒）。	1763710100
Model	string	本次请求使用的模型。	qwen-plus
Choices	array<object>	模型生成内容的候选数组。
Choices	object	模型生成的候选内容
FinishReason	string	终止原因： ● 触发输入参数中的 stop 参数，或自然停止输出时为 stop； ● 生成长度过长而结束为 length； ● 需要调用工具而结束为 tool_call；	stop
Message	object	模型输出的消息体
Content	string	模型的回复内容	你好呀！
ReasoningContent	string	模型的深度思考内容	嗯，用户发了个“你好”，看起来是想打招呼...
Role	string	消息的角色	system
Logprobs	object	模型输出的 Token 概率信息。
	any	详细 token 信息	{}
Usage	object	本次请求的 Token 消耗信息。
CompletionTokens	string	模型输出的 Token 数。	10
PromptTokens	string	输入的 Token 数。	9
TotalTokens	string	消耗的总 Token 数。	19
PromptTokensDetails	object	输入 Token 的细粒度分类。
	string	细粒度 token 分类	{}
CompletionTokensDetails	object	使用 Qwen-VL 模型时输出 Token 的细粒度分类。
	string	细粒度 token 分类	{}
Message	string	报错信息，当 StatusCode 不为 200 的时候会有值	InvalidParameter
StatusCode	string	报错码，200 时为正常调用，其他的为异常	200
Type	string	报错类型	invalid_request_error

示例

正常返回示例

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "Created": 1763710100,
    "Model": "qwen-plus",
    "Choices": [
      {
        "FinishReason": "stop",
        "Message": {
          "Content": "你好呀！",
          "ReasoningContent": "嗯，用户发了个“你好”，看起来是想打招呼...",
          "Role": "system"
        },
        "Logprobs": {
          "key": {}
        }
      }
    ],
    "Usage": {
      "CompletionTokens": 10,
      "PromptTokens": 9,
      "TotalTokens": 19,
      "PromptTokensDetails": {
        "key": {}
      },
      "CompletionTokensDetails": {
        "key": {}
      }
    },
    "Message": "InvalidParameter",
    "StatusCode": 200,
    "Type": "invalid_request_error"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2025-11-26	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情
2025-11-25	新增 OpenAPI	查看变更详情