# 华为云DocZip智能文档服务


## 产品介绍

- [图解DocZip智能文档服务](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002696819666.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [什么是华为云DocZip智能文档服务](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002179334452.md): 华为云DocZip智能文档服务（DocZip）集基础文档服务、智能文档服务与结构化数据治理于一体，面向用户提供一站式协同办公套件，解决办公场景文档处理的效率问题；面向伙伴及开发者全面开放能力及多细粒度接口，支持伙伴灵活调用、按需构建专属智能体。1.
- [产品优势](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002214700377.md): ● 更智能，AI 专业生成1. 自然语言下发指令，复杂任务自动拆分。2. 内置行业专家，输出专业级标准化内容。3. 内置技能中心，免去人工处理重复工作。● 更安全，企业级数据保障1. 底层数据独立隔离存储，杜绝泄露风险。2. 精细化分级权限管控，明确操作权责。3. 全流程日志审计追溯，适配合规审查。● 更高效，多模态解析输出1.
- [应用场景](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002214854765.md): 通用办公● 痛点：1. 当前正处于信息快速迭代期，文档处理仅靠传统人工显然已无法满足需求，AI是办公提效必然选择。2. 文档协作效率低下、版本管理混乱、文档流转滞后等，极易造成团队沟通成本陡增与经验资产损失。3. 组织业务文档，尤其涉及技术敏感信息的相关文档，本就看重信息安全性，AI引入，更放大对“安全”的迫切需求。● 优势：1.
- [产品功能](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002179494140.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [身份认证与访问控制](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002179334464.md): 华为云DocZip智能文档服务提供的身份认证可以分为控制台和云服务两个层面：控制台层面您可以使用华为云用户名与密码登录，实现用户的认证与鉴权，未授权的不能访问。您可以使用华为云用户名与密码登录，实现用户的认证与鉴权，未授权的不能访问。
- [数据保护技术](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002214700389.md): 华为云DocZip智能文档服务通过多种手段和特性，保障用户在使用华为云DocZip智能文档服务时的数据安全可靠。
- [审计与日志](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002214854777.md): 云审计服务（Cloud Trace Service，CTS），是华为云安全解决方案中专业的日志审计服务，提供对各种云资源操作记录的收集、存储和查询功能，可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。用户开通云审计服务后，CTS可记录华为云DocZip智能文档服务的操作事件用于审计。
- [服务韧性](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002179494152.md): 华为云DocZip智能文档服务提供了3级可靠性架构，通过双AZ容灾、AZ内集群容灾、数据容灾技术方案，保障服务的持久性与可靠性。
- [认证证书](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002215931665.md): 华为云服务及平台通过了多项国内外权威机构（ISO/SOC/PCI等）的安全合规认证，用户可自行申请下载合规资质证书。华为云还提供以下资源来帮助用户满足合规性要求，具体请查看资源中心。资源中心另外，华为云还提供了以下销售许可证及软件著作权证书，供用户下载和参考。具体请查看合规资质证书。销售许可证&软件著作权证书
- [权限管理](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002214700397.md): 如果您需要对在华为云上购买的华为云DocZip智能文档服务资源，为企业员工设置不同的访问权限，以实现不同员工之间的权限隔离，您可以使用统一身份认证服务（Identity and Access Management，简称IAM）进行精细的权限管理。该服务提供用户身份认证、权限分配、访问控制等功能，可以帮助您安全的控制华为云资源的访问。
- [约束与限制](https://support.huaweicloud.com/productdesc-doczip/zh-cn_topic_0000002214854785.md): 开通华为云DocZip智能文档服务目前需要完成实名认证即可开通使用。计费华为云账户受限/冻结或者华为云DocZip智能文档服务资源进入保留期时，华为云DocZip智能文档服务使用会受到限制，用户应提前了解处理，避免造成业务影响。更多使用限制请参考华为云DocZip智能文档服务服务声明。

## 计费说明

- [华为云DocZip智能文档服务计费概述](https://support.huaweicloud.com/price-doczip/zh-cn_topic_0000002214854581.md): 通过阅读本文，您可以快速了解华为云DocZip智能文档服务的计费模式、计费项、续费、欠费等主要计费信息。计费模式华为云DocZip智能文档服务提供包年/包月的计费模式。包年/包月是一种预付费模式，即先付费再使用，按照订单的购买周期进行结算，因此在购买之前，您必须确保账户余额充足。华为云DocZip智能文档服务提供包年/包月的计费模式。
- [华为云DocZip智能文档服务计费模式概述](https://support.huaweicloud.com/price-doczip/zh-cn_topic_0000002179334264.md): 包年/包月：一种预付费模式，即先付费再使用，按照订单的购买周期进行结算。购买周期越长，享受的折扣越大。一般适用于需求量长期稳定的成熟业务。-表1 计费模式列出了计费模式。
- [包年/包月](https://support.huaweicloud.com/price-doczip/zh-cn_topic_0000002214700177.md): 包年/包月是一种先付费再使用的计费模式，适用于对资源需求稳定且希望降低成本的用户。通过选择包年/包月的计费模式，您可以预先购买华为云DocZip智能文档服务资源并获得一定程度的价格优惠。本文将介绍包年/包月华为云DocZip智能文档服务资源的计费规则。包年/包月套餐的计费项为购买套餐。
- [计费项](https://support.huaweicloud.com/price-doczip/zh-cn_topic_0000002214700181.md): 华为云DocZip智能文档服务的计费项的具体内容如表1 DocZip智能文档服务计费项所示。
- [续费概述](https://support.huaweicloud.com/price-doczip/zh-cn_topic_0000002179334280.md): 包年/包月续费相关的功能如表1 续费相关的功能所示。在包年/包月套餐生命周期的不同阶段，您可以根据需要选择一种方式进行续费，具体如图 图1 包年/包月生命周期所示。华为云根据客户等级定义了不同客户的宽限期和保留期时长。
- [手动续费](https://support.huaweicloud.com/price-doczip/zh-cn_topic_0000002214700193.md): 包年/包月套餐从购买到被自动删除之前，您可以随时在续费管理页面或者DocZip控制台的“订单详情”页签续费，以延长华为云DocZip智能文档服务的使用时间。进入DocZip控制台。在左侧导航栏中，选择“总览 ”。在订单详情中找到待续费的资源，单击“续费”，进入续费页面。
- [自动续费](https://support.huaweicloud.com/price-doczip/zh-cn_topic_0000002214854601.md): 自动续费可以减少手动续费的管理成本。自动续费的规则如下所述：以华为云DocZip智能文档服务的到期日计算第一次自动续费日期和计费周期。华为云DocZip智能文档服务自动续费周期以您选择的续费时长为准。
- [费用账单](https://support.huaweicloud.com/price-doczip/zh-cn_topic_0000002179493976.md): 您可以在“费用中心 > 账单管理”查看资源的费用账单，以了解该资源的计费信息。账单上报周期包年/包月计费模式的资源完成支付后，会实时上报一条账单到计费系统进行结算。查看资源的账单登录费用中心管理控制台。在页面上方选择“费用 > 费用账单”，进入“账单概览”页面。
- [欠费说明](https://support.huaweicloud.com/price-doczip/zh-cn_topic_0000002179334284.md): 用户在使用云服务时，账户的可用额度小于待结算的账单，即被判定为账户欠费，请及时充值。自动续费情况下，可能会因持续性周期扣款而导致账户的余额不足。系统会在每个计费周期后的一段时间对按需计费资源进行扣费。当您的账户被扣为负值时，系统将通过邮件、短信和站内信的方式通知到华为云账号的创建者。
- [停止计费](https://support.huaweicloud.com/price-doczip/zh-cn_topic_0000002214700197.md): 对于包年/包月计费模式的资源，用户在购买时会一次性付费，服务将在到期后自动停止使用。如果在计费周期内不再使用包年/包月资源，您可以执行退订操作，系统将根据资源是否属于五天无理由退订、是否使用代金券和折扣券等条件返还一定金额到您的账户。详细的退订规则请参见云服务退订规则概览。

## 快速入门

- [入门指引](https://support.huaweicloud.com/qs-doczip/zh-cn_topic_0000002761469693.md): 本文档将为您介绍华为云DocZip智能文档服务的入门流程及相关操作。通过本文档，您可以了解如何集成华为云DocZip智能文档服务。
- [前提条件](https://support.huaweicloud.com/qs-doczip/zh-cn_topic_0000002761362527.md): 集成DocZip服务前，请您确保已满足以下条件：请您先注册华为账号，详情请参见注册华为云账号。完成账号注册后，请继续完成企业账号实名认证，具体操作请参考实名认证。已申请公测华为云DocZip智能文档服务，具体操作请参考申请公测DocZip服务
- [开通DocZip服务](https://support.huaweicloud.com/qs-doczip/zh-cn_topic_0000002731733754.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [创建应用](https://support.huaweicloud.com/qs-doczip/zh-cn_topic_0000002696399749.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [编辑应用](https://support.huaweicloud.com/qs-doczip/zh-cn_topic_0000002666440046.md): 应用创建完成后，需要完成身份提供方（IdP）配置。
- [发布应用](https://support.huaweicloud.com/qs-doczip/zh-cn_topic_0000002696279861.md): 应用创建完成后，如果尚未发布，将显示为待上线状态。您可选择将其发布，发布后的应用将显示为已启用状态。对于已启用的应用，如果后续有更新时，您可以将其再次发布。应用发布成功后，其配置信息才会生效。
- [集成DocZip服务](https://support.huaweicloud.com/qs-doczip/zh-cn_topic_0000002761383265.md): 您可以将文档能力嵌入自己的 Web、移动端、桌面端、后台服务或智能体应用，构建合同文档、办公文档等自己的文档/智能体产品。您可以选择以下DocZip提供的开放能力，开发您的智能文档应用。

## 用户指南

- [注册华为云账号](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002763052703.md): 可通过手机号注册或账号密码注册。具体操作请参考注册华为云账号
- [完成实名认证](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002763052757.md): 已完成注册华为云账号。参考实名认证完成企业账号实名认证，目前只有企业账号才能开通DocZip服务。
- [申请公测DocZip服务](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002179494108.md): 华为云DocZip智能文档服务服务目前处于公测阶段，需要先申请公测并通过审核后才可以使用。由于公测期间资源有限，仅限已通过实名认证的企业华为账号申请公测。公测申请提交后，5个工作日内审核结果将发送到您的邮箱和手机。
- [通过IAM授予使用DocZip的权限](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002763052967.md): 如果您需要对您所拥有的华为云DocZip智能文档服务服务进行精细的权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM），通过IAM，您可以：根据企业的业务组织，在您的华为云账号中，给企业中不同职能部门的员工创建IAM用户，让员工拥有唯一安全凭证，并使用华为云DocZip智能文档服
- [概述](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002733298474.md): 应用是文档开发的核心载体。开发者需先在控制台创建应用，完成配置并发布后，应用方可正式生效。进入应用管理模块，您将看到所有已创建的应用列表，并支持以下操作：创建应用、发布应用、查看应用历史记录、编辑应用信息、搜索应用及删除应用。创建应用：新建业务应用。编辑应用：修改应用的基础信息以及相关配置。发布应用：提交已配置的应用，使最新配置正式生效。
- [创建应用](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002762861261.md): 华为云帮助中心，为用户提供产品简介、价格说明、购买指南、用户指南、API参考、最佳实践、常见问题、视频帮助等技术文档，帮助您快速上手使用华为云服务。
- [编辑应用](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002733462488.md): 您可以对已创建或发布后的应用进行再次编辑。编辑内容包括应用的基础信息、文档块以及系统配置。完成编辑后，需要重新发布应用，更改后的信息才会生效。您可以通过文档块配置，轻松实现在云文档中定制文档块菜单的需求。系统预置了文档块数据，包括文本、通用、AI辅助、样式布局、媒体、小工具、画板图形和基础控件等文档块。您可以对此进行编辑。
- [发布应用](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002733302670.md): 应用创建完成后，如果尚未发布，将显示为待上线状态。您可选择将其发布，发布后的应用将显示为已启用状态。对于已启用的应用，如果后续有更新时，您可以将其再次发布。应用发布成功后，其配置信息才会生效。
- [查看应用历史记录](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002763022169.md): 您可以查看应用的历史记录，包括应用的历史名称、历史更新说明和历史发布时间。
- [搜索应用](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002733302804.md): 在应用列表窗口中，您可以浏览所有的应用，并了解它们当前的状态。如果应用较多，可以在搜索框中输入应用全称或名称关键字快速查找。
- [删除应用](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002733462726.md): 系统提供了删除应用功能，以便您能删除多余的应用。删除应用后无法恢复，请谨慎操作。
- [权限管理](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002214854745.md): 如果您需要对华为云上购买的DocZip资源，为企业员工设置不同的访问权限，以实现不同员工之间的权限隔离，您可以使用统一身份认证服务（Identity and Access Management，简称IAM）进行精细的权限管理。该服务提供用户身份认证、权限分配、访问控制等功能，可以帮助您安全地控制华为云资源的访问。
- [查询审计日志](https://support.huaweicloud.com/usermanual-doczip/zh-cn_topic_0000002214700357.md): 平台提供了云审计服务（Cloud Trace Service，简称CTS）。通过云审计服务，可记录与华为云DocZip智能文档服务相关的操作事件，便于日后的查询、审计和回溯。已开通云审计服务。用户需要在云审计服务CTS的管理控制台查询华为云DocZip智能文档服务服务的事件列表。详情请参考：查看审计日志（审计事件）。

## 开发指南

- [使用前必读](https://support.huaweicloud.com/devg-doczip/zh-cn_topic_0000002733498442.md): DocZip 提供文档管理、内容访问和协同编辑三大核心能力。支持将云文档库与编辑器直接嵌入自有系统，或通过开放接口集成至业务流程，开发者可按需灵活选择接入方案。在集成 DocZip 服务前，请先参考快速入门，以此完成以下操作应用创建身份提供方（IdP）配置应用发布集成方：集成DocZip开放能力的企业或开发者。
- [身份认证与授权](https://support.huaweicloud.com/devg-doczip/zh-cn_topic_0000002733507940.md): DocZip 对三类身份进行统一管理，分别对应服务管理、应用接入、文档访问三类场景。请根据接口类型使用对应凭证。IAM 管理员拥有应用配置管理权限，不代表该管理员的业务身份可读取应用下全部文档。管理权限与文档访问权限相互独立。
- [场景1：Web/H5嵌入云文档界面](https://support.huaweicloud.com/devg-doczip/zh-cn_topic_0000002733510966.md): 您可以在业务页面中嵌入云文档的文档库或编辑器。集成方提供业务入口与业务侧逻辑，云文档提供文档界面和文档操作能力。
- [场景2：后端API集成](https://support.huaweicloud.com/devg-doczip/zh-cn_topic_0000002733512168.md): 您可以通过调用DocZip开放API，将DocZip能力无缝集成至您的业务系统，实现文档与业务流程的深度融合。当前 API 开放的具体能力如下表1 开放能力所示，后续将有更多能力陆续开放，敬请期待。
- [场景3：MCP智能体接入（待开放）](https://support.huaweicloud.com/devg-doczip/zh-cn_topic_0000002789716271.md): 支持 MCP 协议的智能体可自动发现、调用文档工具，让智能体原生具备文档读写能力。该能力后续开放。
- [场景4：CLI命令行接入（待开放）](https://support.huaweicloud.com/devg-doczip/zh-cn_topic_0000002789716703.md): 终端命令行方式访问云文档，适合脚本批量运维场景。此能力后续开放。
- [测试与验收场景](https://support.huaweicloud.com/devg-doczip/zh-cn_topic_0000002763072247.md): 完成接入开发后，请使用独立测试资源，对身份鉴权、权限控制与业务操作结果开展验证。联调阶段需同时覆盖正常业务流程与各类典型异常场景。

## API参考

- [使用前必读](https://support.huaweicloud.com/api-doczip/zh-cn_topic_0000002214854521.md): 欢迎使用华为云DocZip智能文档服务。华为云DocZip智能文档服务是以新型文档为载体，配合多样化的文档模块、以实时协同的组织方式，为个人和团队提供数字信息管理与协同的一站式工作中心。
- [API概览](https://support.huaweicloud.com/api-doczip/zh-cn_topic_0000002214700117.md): 华为云DocZip智能文档服务接口的分类与说明如表1 API概览所示。
- [构造请求](https://support.huaweicloud.com/api-doczip/zh-cn_topic_0000002214854525.md): 本节介绍REST API请求的组成，并以使用Token Exchange模式获取access_token为例说明如何调用API，该API获取access_token，access_token可以用于调用其他API时鉴权。请求URI由如下部分组成。{URI-scheme} :// {Endpoint} / {resource-path} ?
- [认证鉴权](https://support.huaweicloud.com/api-doczip/zh-cn_topic_0000002214700121.md): DocZip开放API提供的所有接口都需要通过认证之后才可以访问。认证方式为：通过认证接口获取access_token，在请求消息头上设置"Authorization"携带access_token进行鉴权。Token在计算机系统中代表令牌（临时）的意思，拥有Token代表拥有某种权限。
- [返回结果](https://support.huaweicloud.com/api-doczip/zh-cn_topic_0000002179493900.md): 请求发送以后，您会收到响应，包含状态码、响应消息头和消息体。状态码是一组从2xx（成功）到4xx或5xx（错误）的数字代码，状态码表示了请求响应的状态，完整的状态码列表请参见状态码。
- [申请令牌 - CreateEmbedAuthToken](https://support.huaweicloud.com/api-doczip/CreateEmbedAuthToken.md): 通过Token Exchange协议获取用户令牌。POST /v1/app/auth/token状态码：200状态码：400状态码：500使用subject_token值为aaa.bbb.ccc的换取用户access_token。状态码：200状态码：400请参见错误码。
- [刷新令牌 - RefreshEmbedAuthToken](https://support.huaweicloud.com/api-doczip/RefreshEmbedAuthToken.md): 在access_token过期前，使用refresh_token换取新的令牌。POST /v1/app/auth/token/refresh状态码：200状态码：400状态码：500使用refresh_token值为aaa.bbb.ccc换取新的access_token。状态码：200状态码：400请参见错误码。
- [签发一次性会话 ticket - CreateEmbedAuthSessionTicket](https://support.huaweicloud.com/api-doczip/CreateEmbedAuthSessionTicket.md): 签发一次性会话ticket，用于建立会话。POST /v1/app/auth/session/ticket状态码：200状态码：400状态码：500使用请求头中的Authorization字段的值换取一次性ticket。状态码：200状态码：400请参见错误码。
- [撤销令牌 - RevokeEmbedAuthToken](https://support.huaweicloud.com/api-doczip/RevokeEmbedAuthToken.md): 主动撤销 access_token 或 refresh_token。POST /v1/app/auth/token/revoke状态码：200状态码：400状态码：500撤销token_type类型为access_token，值aaa.bbb.ccc的用户token。状态码：200无状态码：400请参见错误码。
- [查询空间列表 - ListOrganization](https://support.huaweicloud.com/api-doczip/ListOrganization.md): 根据条件查询用户名下的所有或部分空间列表。GET /v1/app/organizations状态码：200状态码：400状态码：500查询个人文档库。状态码：200状态码：400请参见错误码。
- [查询指定空间下的文档库 - ListDocbaseInOrganization](https://support.huaweicloud.com/api-doczip/ListDocbaseInOrganization.md): 根据条件查询指定空间下的文档库详情，用于文档库管理或者创建文档。GET /v1/app/organizations/{organization_id}/wikis状态码：200状态码：400查询空间id为cXXXXXXX2-bfb0-0XXXXX1af7的前50个文档库。状态码：200状态码：400请参见错误码。
- [文档软删除 - DeleteDocumentSoft](https://support.huaweicloud.com/api-doczip/DeleteDocumentSoft.md): 软删除文档，执行后文档被放到回收站。POST /v1/app/documents/softdelete/{document_id}状态码：200状态码：400删除文档d3XXX1-0fb8-4926-8f34-6XXXX11。状态码：200无状态码：400请参见错误码。
- [创建目录或文档 - CreateDocument](https://support.huaweicloud.com/api-doczip/CreateDocument.md): 创建目录或文档。POST /v1/app/documents状态码：200状态码：400状态码：200状态码：400请参见错误码。
- [获取文档详情 - ShowDocumentDetail](https://support.huaweicloud.com/api-doczip/ShowDocumentDetail.md): 获取文档详情GET /v1/app/documents/{document_id}状态码：200状态码：400查询文档id为d3XXXX1-0fb8-4926-8fXXXXX67511的信息和内容。状态码：200状态码：400请参见错误码。
- [创建page文档 - CreatePage](https://support.huaweicloud.com/api-doczip/CreatePage.md): 该接口用于创建带内容的page文档。POST /v1/app/aipage状态码：200状态码：400创建一篇page文档，父文档id为doc_parent_001。状态码：200请求成功。状态码：400错误响应。请参见错误码。
- [读取page文档 - ListPage](https://support.huaweicloud.com/api-doczip/ListPage.md): 读取page文档。POST /v1/app/aipage/{document_id}/fetch状态码：200状态码：400获取文档id为d37XXXXX1-0fb8-4926-8f3X-67XXXX11的文档块数据。状态码：200请求成功。状态码：400错误响应。请参见错误码。
- [状态码](https://support.huaweicloud.com/api-doczip/zh-cn_topic_0000002179334224.md): 常用状态码请参见表1 请求状态返回码。
- [错误码](https://support.huaweicloud.com/api-doczip/ErrorCode.md): 为了帮助您快速定位问题，错误码请参考表1 错误码。

## 常见问题

- [DocZip集成常见问题](https://support.huaweicloud.com/doczip_faq/zh-cn_topic_0000002214700325.md): 应用是对接DocZip智能文档服务能力的基础载体，集成DocZip开放能力前，需要先在控制台中创建业务应用，创建完成后系统分配App ID与App Secret，作为云文档集成的核心应用凭据。创建应用的操作步骤，请参考《用户指南》中的应用管理章节。