作為 Python 開發人員，您可以在雲上以編程方式註釋任何 Word(.doc 或 .docx)文件。註釋通常是元數據，形式為註釋、註釋、解釋或文檔中其他類型的外部註釋，提供有關現有數據的附加信息。本文將重點介紹如何在 Python 中使用 REST API 註釋 DOCX 文件。

本文應涵蓋以下主題：

文檔註釋 REST API 和 Python SDK

GroupDocs.註釋雲

為了註釋 DOC 或 DOCX 文檔，我將使用 GroupDocs.Annotation Cloud 的 Python SDK API。它允許您以編程方式構建在線文檔和圖像註釋工具。此類工具可用於向所有流行格式的業務文檔添加註釋、水印疊加、文本替換、編輯、便籤和文本標記。它還為雲 API 提供 .NET、Java、PHP、Ruby 和 Node.js SDK 作為其 文檔註釋系列成員。

您可以在控制台中使用以下命令將 GroupDocs.Annotation Cloud 安裝到您的 Python 項目：

pip install groupdocs_annotation_cloud

在開始執行步驟和可用代碼示例之前，請從 dashboard 獲取您的 Client ID 和 Client Secret。在代碼中添加您的 ID 和密碼，如下所示：

client_id = "112f0f38-9dae-42d5-b4fc-cc84ae644972"
client_secret = "16ad3fe0bdc39c910f57d2fd48a5d618"
my_storage = ""

configurations = groupdocs_annotation_cloud.Configuration(client_id, client_secret)
configurations.api_base_url = "https://api.groupdocs.cloud"

在 Python 中使用 REST API 註釋 DOCX 文件

您可以按照下面提到的簡單步驟向 DOCX 文件添加註釋：

上傳文件

首先，使用下面給出的代碼示例將 DOCX 文件上傳到雲端：

# 創建 API 實例
file_api = groupdocs_annotation_cloud.FileApi.from_config(configurations)

request = groupdocs_annotation_cloud.UploadFileRequest("one-page.docx", "C:\\Files\\one-page.docx", my_storage)
response = file_api.upload_file(request)

因此，上傳的 DOCX 文件將在雲端儀表板的 文件部分 中可用。

在 Python 中向 DOCX 文件添加註釋

請按照下面提到的步驟以編程方式在 Word 文檔中插入註釋。

  • 創建 AnnotationInfo 的實例
  • 設置各種註釋屬性，例如位置、類型、文本等。
  • 創建一個 FileInfo 實例
  • 設置文件路徑
  • 創建 AnnotateOptions 的實例
  • 將文件信息設置為 AnnotateOptions
  • 將註釋設置為 AnnotateOptions
  • 通過調用 AnnotateRequest 方法創建請求
  • 調用AnnotateApi.annotate()方法獲取結果

以下代碼片段顯示瞭如何使用 REST API 在 Word 文檔中插入區域註釋。

api = groupdocs_annotation_cloud.AnnotateApi.from_keys(client_id, client_secret)

a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 100
a1.box.y = 100
a1.box.width = 200
a1.box.height = 100
a1.page_number = 0
a1.pen_color = 1201033
a1.pen_style = "Solid"
a1.pen_width = 1
a1.opacity = 0.7

# 添加區域註釋
a1.type = "Area"
a1.text = "This is area annotation"
a1.creator_name = "Anonym A."

file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "one-page.docx"
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "Output\\output.docx"

request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)

結果，區域註釋將插入文檔中，如下所示。

在 Python 中向 DOCX 文件添加註釋

支持的註解類型

請在下面找到支持的註釋類型列表，您可以按照前面提到的步驟將其添加到您的 DOCX 文件中：

  • 區域
  • 距離
  • 關聯
  • 觀點
  • 折線
  • 圖像
  • 文本
  • 水印
  • 箭

下載更新文件

上面的代碼示例會將帶註釋的 DOCX 文件保存在雲端。您可以使用以下代碼示例下載它：

# 創建 API 實例
file_api = groupdocs_annotation_cloud.FileApi.from_config(configurations)

request = groupdocs_annotation_cloud.DownloadFileRequest("Output\\output.docx", my_storage)
response = file_api.download_file(request)

# 將下載的文件移動到您的工作目錄
shutil.move(response, "C:\\Files\\")

使用 Python 添加多個註釋

請按照下面提到的步驟以編程方式向您的 DOCX 文件添加多個註釋。

  • 創建 AnnotationInfo 的第一個實例
  • 為第一個實例設置各種註釋屬性，例如位置、類型、文本等。
  • 創建 AnnotationInfo 第二個實例
  • 為第二個實例設置各種註釋屬性，例如位置、類型、文本等。
  • 創建一個 FileInfo 實例
  • 設置文件路徑
  • 創建 AnnotateOptions 的實例
  • 將文件信息設置為 AnnotateOptions
  • 將第一個和第二個註釋設置為 AnnotateOptions
  • 通過調用 AnnotateRequest 方法創建請求
  • 調用AnnotateApi.annotate()方法獲取結果

以下代碼片段顯示瞭如何使用 REST API 向 DOCX 文件添加多個註釋。請按照前面提到的步驟上傳和下載文件。

api = groupdocs_annotation_cloud.AnnotateApi.from_keys(client_id, client_secret)
  
a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 200
a1.box.y = 200
a1.box.width = 300
a1.box.height = 100
a1.page_number = 0
a1.pen_color = 1201033
a1.pen_style = "Solid"
a1.pen_width = 1
a1.opacity = 0.2
a1.type = "Watermark"
a1.text = "This is watermark annotation"
a1.creator_name = "Anonym A."
    
a2 = groupdocs_annotation_cloud.AnnotationInfo()
a2.annotation_position = groupdocs_annotation_cloud.Point()
a2.annotation_position.x = 852
a2.annotation_position.y = 59.38
a2.box = groupdocs_annotation_cloud.Rectangle()
a2.box.x = 375.8
a2.box.y = 59.38
a2.box.width = 88
a2.box.height = 37
a2.page_number = 2
a2.pen_color = 1201033
a2.pen_style = "Solid"
a2.pen_width = 1
a2.opacity = 0.9
a2.type = "Image"
a2.text = "This is Image annotation"
a2.creator_name = "Anonym A."
a2.image_path = "JohnSmith.png"
    
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "ten-pages.docx"
options = groupdocs_annotation_cloud.AnnotateOptions()
options.file_info = file_info
options.annotations = [a1, a2]
options.output_path = "Output\\output.docx"

request = groupdocs_annotation_cloud.AnnotateRequest(options)
result = api.annotate(request)

結果，圖像和水印註釋將插入文檔中，如下所示。

圖像和水印註釋

結論

在本文中，您了解瞭如何使用 Python 使用 Document Annotation REST API 向雲上的 Word 文檔添加各種類型的註釋。您還學習瞭如何以編程方式將 DOCX 文件上傳到雲端，然後從雲端下載帶註釋的文件。您可以使用 文檔 了解有關 GroupDocs.Annotation Cloud API 的更多信息。我們還提供了一個 API 參考 部分，讓您可以直接通過瀏覽器可視化我們的 API 並與之交互。如有任何歧義，請隨時在論壇上與我們聯繫。