Skip to main content

更新个性化策略组

千问办公企业旗舰版开发者文档:更新个性化策略组。

  • Scope: admin.v1.personalization-policy-groups.manage
  • 接口: PATCH/api/openapi/v1/personalization/policy-groups/{group_id}
一次提交基本信息和变更分区;任一校验失败均不生效。省略的分区保持原值,提交的分区整体保存。只改欢迎语时请先读取 homepage 并保留推荐配置。默认组基本信息只读。「个性化策略组管理」权限覆盖基本信息和所有配置分区。版本冲突返回 409,请重新读取组并合并修改。

公共请求头

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

请求参数

请求体:必填;Content-Type:application/json。
名称位置类型必填说明示例
group_idpathstring是目标策略组 ID-
enabledbodyboolean否是否启用-
expected_revisionbodyinteger · int64 | null是上次读取的组织管理版本-
namebodystring否显示名称-
prioritybodyinteger · int64否匹配顺序,数值小的优先-
scopebodyobject否策略生效人群-
sectionsbodyobject否按名称区分的配置分区-

body.scope 字段

字段类型必填说明
all_usersboolean是匹配全体用户,开启后不再指定成员
department_idsarray<string> | null是匹配的部门 ID
user_group_idsarray<string> | null是匹配的用户组 ID
user_idsarray<string> | null是匹配的用户 ID

body.sections 字段

字段类型必填说明
credit-shortageobject否积分不足提示和操作按钮
credit-usageobject否积分用量展示方式和地址
homepageobject否新任务首页欢迎语、推荐内容及显隐设置
input-placeholderobject否正常输入和生成状态下的提示文案
navigationobject否导航树、用户菜单及咨询入口

body.sections.credit-shortage 字段

字段类型必填说明
actionEnabledboolean否展示操作按钮
actionNameobject否积分操作按钮名称
actionURLstring否积分操作跳转链接
descriptionobject否提示说明
enabledboolean否是否启用
titleobject否提示标题

body.sections.credit-shortage.actionName 字段

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

body.sections.credit-shortage.description 字段

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

body.sections.credit-shortage.title 字段

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

body.sections.credit-usage 字段

字段类型必填说明
embeddedUrlstring否内嵌用量页面地址
modestring否展示方式 取值:"default"、"embedded"、"redirect"
redirectUrlstring否外部用量页面地址

body.sections.homepage 字段

字段类型必填说明
recommendedPromptsarray<object>否首页推荐语
visibilityobject否首页模块显隐开关
welcomeobject否首页欢迎语

body.sections.homepage.recommendedPrompts[] 字段

字段类型必填说明
categorystring否推荐语分类
createdAtstring否推荐语创建时间
createdByEmailstring否推荐语创建者邮箱
createdByNamestring否推荐语创建者名称
displayPromptstring否展示文案
enabledboolean否是否启用
idstring否记录标识
inputPromptstring否实际填入输入框的文案
sourceRecordIdstring否推荐语来源记录
updatedAtstring否推荐语更新时间
updatedByEmailstring否推荐语修改者邮箱
updatedByNamestring否推荐语修改者名称

body.sections.homepage.visibility 字段

字段类型必填说明
featureSpotlightsobject否功能亮点入口
recommendedPromptsobject否首页推荐语

body.sections.homepage.visibility.featureSpotlights 字段

字段类型必填说明
visibleboolean否是否展示

body.sections.homepage.visibility.recommendedPrompts 字段

字段类型必填说明
visibleboolean否是否展示

body.sections.homepage.welcome 字段

字段类型必填说明
enstring否英文文案
withProjectobject否在项目内工作时的欢迎语
withoutProjectobject否无项目时的欢迎语
zh-CNstring否简体中文文案
zh-TWstring否繁体中文文案

body.sections.homepage.welcome.withProject 字段

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

body.sections.homepage.welcome.withoutProject 字段

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

body.sections.input-placeholder 字段

字段类型必填说明
generatingobject否AI 回复中
normalobject否正常输入状态

body.sections.input-placeholder.generating 字段

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

body.sections.input-placeholder.normal 字段

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

body.sections.navigation 字段

字段类型必填说明
consultationobject否产品咨询与建议入口
nodesarray<object>否导航节点列表
userMenuobject否用户菜单项

body.sections.navigation.consultation 字段

字段类型必填说明
copyobject是咨询入口文案
customUrlstring是自定义咨询链接
enabledboolean是是否启用
modestring是展示方式

body.sections.navigation.consultation.copy 字段

字段类型必填说明
buttonstring是按钮文案
buttonI18nobject否各语言按钮文案
descriptionstring是提示说明
descriptionI18nobject否各语言说明
tagsstring是咨询标签
tagsI18nobject否各语言标签
titlestring是提示标题
titleI18nobject否各语言标题

body.sections.navigation.nodes[] 字段

字段类型必填说明
customboolean否是否自定义
enabledboolean否是否启用
iconstring否图标名称
idstring否记录标识
kindstring否节点类型
lockedboolean否内置锁定节点
namestring否显示名称
nameI18nobject否各语言显示名称
openModestring否链接打开方式
parentIdstring | null否父节点 ID,顶层为空
pluginobject否节点的 Web 插件
urlstring否打开的链接

body.sections.navigation.nodes[].nameI18n 字段

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

body.sections.navigation.nodes[].plugin 字段

字段类型必填说明
envVarsstring否注入插件的环境变量 JSON
routestring否插件访问路由
sourcestring否插件来源
versionstring否已发布的插件版本
webobject否已发布插件的 Web 资源
webUploadIdstring否待发布插件包的上传会话 ID

body.sections.navigation.nodes[].plugin.web 字段

字段类型必填说明
keystring否同一组织内的插件包对象键
kindstring否节点类型
sha256string否插件包摘要
sizeBytesinteger否已发布插件包的字节数
urlstring否打开的链接

body.sections.navigation.userMenu 字段

字段类型必填说明
fixedobject否四个内置入口的可见性
itemsarray<object>否可编辑的菜单项

body.sections.navigation.userMenu.fixed 字段

字段类型必填说明
balanceobject否积分余额入口
organizationobject否企业/团队入口
planobject否套餐入口
preferencesobject否偏好设置入口

body.sections.navigation.userMenu.fixed.balance 字段

字段类型必填说明
visibleboolean否是否展示

body.sections.navigation.userMenu.fixed.organization 字段

字段类型必填说明
visibleboolean否是否展示

body.sections.navigation.userMenu.fixed.plan 字段

字段类型必填说明
visibleboolean否是否展示

body.sections.navigation.userMenu.fixed.preferences 字段

字段类型必填说明
visibleboolean否是否展示

body.sections.navigation.userMenu.items[] 字段

字段类型必填说明
customboolean否是否自定义
iconstring是图标名称
idstring是记录标识
namestring是显示名称
nameI18nobject否各语言显示名称
openModestring否链接打开方式
urlstring是打开的链接
visibleboolean是是否展示

请求示例

curl --request PATCH \
  --url 'https://example.invalid/api/openapi/v1/personalization/policy-groups/11111111-1111-4111-8111-111111111111' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{"expected_revision":1,"sections":{"input-placeholder":{"normal":{"zh-CN":"描述任务","en":"Describe your task"},"generating":{"zh-CN":"添加到队列","en":"Queue a task"}}}}'

响应状态表

HTTP 状态码触发条件响应结构引用客户端处理建议
200请求成功见本文“响应结果”读取响应
429限流或准入依赖不可用见《通过 API 配置 QwenWork 管理后台》的“限流错误”结构按状态码及错误码处理
503限流或准入依赖不可用见《通过 API 配置 QwenWork 管理后台》的“限流错误”结构按状态码及错误码处理
default其他认证、授权、版本冲突或校验错误见《通过 API 配置 QwenWork 管理后台》的“通用错误”结构按状态码及错误码处理

响应结果

Content-Type: application/json
名称类型必填说明示例
group_idstring是目标策略组 ID-
revisioninteger · int64是当前版本。列表和组详情顶层为组织管理版本,分区内为该分区的发布版本-

响应示例

{
  "revision": 1,
  "group_id": "11111111-1111-4111-8111-111111111111"
}