Skip to main content

发布输入框提示文案

千问办公企业旗舰版开发者文档:发布输入框提示文案。

  • Scope: admin.v1.personalization.manage
  • 权限项: 个性化配置管理
  • 权限类型: manage
  • 接口: POST/api/openapi/v1/personalization/configs/input-placeholder/publications
使用 Authorization: Bearer <API_KEY>。应用必须配置全部用户范围 subject_scope={"mode":"all"},受限范围返回 403。各 Scope 独立授权。响应不应缓存。 复用 UI 个性化服务。发布是整段配置替换,必须携带当前 expected_revision;版本冲突返回 409。更新首页欢迎语时应先读取并保留首页的其他字段。登录背景采用独立上传会话:提交 media_type 和 size_bytes,按返回的 URL、方法及请求头直传文件,然后在登录 config.backgroundUploadId 中引用 upload_id 并发布。PNG/JPEG 最大 5 MiB、至少 720×720;会话绑定组织与上传者。登录背景会话要求 Idempotency-Key。此组旧分区接口覆盖 login、homepage、input-placeholder。按策略组保存配置请使用 policy-groups 接口。

公共请求头

适用《通过 API 配置 QwenWork 管理后台》的“认证与请求头”章节:Authorization 必填,X-Request-Id 可选;当前接口所需 Scope 见本页。Idempotency-Key 是否适用及必填性以本页请求参数为准,不能用追踪标识替代幂等键。

请求参数

请求体:必填;Content-Type:application/json。
名称位置类型必填说明示例
configbodyobject是分区配置;初始值为 {}-
expected_revisionbodyinteger · int64是最近一次读取的版本号; format="int64", minimum=0-

body.config 字段

字段类型必填说明
generatingobject否生成状态提示语
normalobject否普通状态提示语

body.config.generating 字段

字段类型必填说明
enstring否英文文案
zh-CNstring否简体中文文案

body.config.normal 字段

字段类型必填说明
enstring否英文文案
zh-CNstring否简体中文文案

请求示例

curl --request POST \
  --url 'https://example.invalid/api/openapi/v1/personalization/configs/input-placeholder/publications' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
  "config": {},
  "expected_revision": 0
}'

响应状态表

HTTP 状态码触发条件响应结构引用客户端处理建议
201请求成功见本文“响应结果”读取响应结果。
default未单独列出的认证、授权、校验或依赖错误见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构按状态与 code 处理;写操作重试前核实结果及幂等要求。

响应结果

Content-Type: application/json
名称类型必填说明示例
configobject是分区配置;初始值为 {}-
product_editionstring否产品部署版本类型; enum=["vpc", "k8s"] 取值:"k8s"、"vpc"-
publication_idstring是发布记录 ID-
published_atstring · date-time是发布时间; format="date-time"-
revisioninteger · int64是当前版本号,用于并发控制; format="int64"-
sectionstring是个性化配置分区-
successboolean是是否成功-

config

字段类型必填说明
generatingobject否生成状态提示语
normalobject否普通状态提示语

config.generating

字段类型必填说明
enstring否英文文案
zh-CNstring否简体中文文案

config.normal

字段类型必填说明
enstring否英文文案
zh-CNstring否简体中文文案

运行时限制与协议说明

HTTP 409 / personalization_revision_conflict 在服务端知道当前版本时附带 current_revision(integer,可选);未附带时先读取最新配置,不假定其为 0。

错误与重试

保留现有 UI 服务的错误码与校验。401/403 表示认证或授权失败;409 表示冲突,应重新读取后重试;413 表示请求过大;400/422 表示参数校验失败;503 表示依赖不可用。以实际响应及机器契约为准。创建类幂等操作重试应使用相同 Idempotency-Key 与相同请求。

config 字段与校验边界

normal(普通状态)与 generating(生成状态)各为 zh-CN、en 字符串对象。UI 要求内容非空、输入最多 128 字符;缺省采用对应语言的产品提示语。首次存储值为 {},接口不替 UI 填充默认提示语。服务端沿用 JSON 对象校验,不新增 UI 长度和必填校验。 以下仅为 config 配置片段,不是完整请求或响应。
{"normal":{"zh-CN":"请输入问题","en":"Ask a question"},"generating":{"zh-CN":"正在生成","en":"Generating"}}