Python 開発者は、クラウド上の任意の Word (.doc または .docx) ファイルにプログラムで注釈を付けることができます。 Python を使用して Word ファイルからすべての注釈を抽出または削除することもできます。注釈には、コメント、ポップアップ、および追加情報を提供するドキュメント内のその他のさまざまなグラフィック オブジェクトが含まれます。この記事では、Python の REST API を使用して DOCX ファイルから注釈を抽出または削除する方法に焦点を当てます。
この記事では次のトピックについて説明します。
ドキュメント注釈 REST API と Python SDK
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
手順と利用可能なコード例を開始する前に、ダッシュボード からクライアント ID とクライアント シークレットを取得してください。 ID とシークレットを取得したら、以下に示すようにコードを追加します。
client_id = "da0c487d-c1c0-45ae-b7bf-43eaf53c5ad5"
client_secret = "479db2b01dcb93a3d4d20efb16dea971"
configuration = groupdocs_annotation_cloud.Configuration(client_id, client_secret)
configuration.api_base_url = "https://api.groupdocs.cloud"
Python の REST API を使用して DOCX ファイルから注釈を抽出または削除する
以下に示す簡単な手順に従って、DOCX ファイルからすべての注釈を抽出または削除できます。
- DOCXファイルをクラウドにアップロード
- Python で DOCX ファイルから注釈を抽出
- Python で DOCX ファイルから注釈を削除する
- ダウンロード 更新されたファイル
ドキュメントをアップロードする
まず、以下のコード例を使用して、DOCX ファイルをクラウドにアップロードします。
# APIインスタンス
file_api = groupdocs_annotation_cloud.FileApi.from_config(configuration)
# ファイルをアップロードする
request = groupdocs_annotation_cloud.UploadFileRequest("input.docx", "C:\\Files\\input.docx", my_storage)
response = file_api.upload_file(request)
その結果、アップロードされた DOCX ファイル (input.docx) は、クラウド上のダッシュボードの ファイル セクション で利用できるようになります。
Python で DOCX ファイルから注釈を抽出する
Word 文書からプログラムで注釈を抽出するには、以下の手順に従ってください。
- AnnotateApi のインスタンスを作成する
- FileInfo インスタンスを作成する
- ファイルパスを設定する
- ExtractRequest メソッドを呼び出してリクエストを作成する
- AnnotateApi.extract() メソッドを呼び出して結果を取得します
次のコード スニペットは、REST API を使用して Word 文書から注釈を抽出する方法を示しています。
# APIインスタンス
api = groupdocs_annotation_cloud.AnnotateApi.from_config(configuration)
# 入力ファイルの詳細
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "input.docx"
# 注釈の抽出リクエスト
request = groupdocs_annotation_cloud.ExtractRequest(file_info)
result = api.extract(request)
print("ExtractAnnotations: annotations count: " + str(len(result)))
上記のコード サンプルは、以下に示すように、すべての注釈の配列を JSON 形式で返します。
Python で DOCX ファイルから注釈を削除する
Word 文書から注釈をプログラムで削除するには、以下の手順に従ってください。
- AnnotateApi のインスタンスを作成する
- FileInfo インスタンスを作成する
- ファイルパスを設定する
- RemoveOptions の定義
- ファイル情報を AnnotateOptions に設定する
- 削除する注釈 ID を指定してください
- 出力ファイルのパスを設定する
- RemoveAnnotationsRequest メソッドを呼び出してリクエストを作成します。
- AnnotateApi.remove\annotations() メソッドを呼び出して結果を取得します
次のコード スニペットは、REST API を使用して Word 文書から注釈を削除する方法を示しています。ドキュメントから削除する必要がある注釈 ID について言及する必要があります。
# APIインスタンス
api = groupdocs_annotation_cloud.AnnotateApi.from_keys(client_id, client_secret)
# 入力ファイルの詳細
file_info = groupdocs_annotation_cloud.FileInfo()
file_info.file_path = "input.docx"
# オプションを削除する
options = groupdocs_annotation_cloud.RemoveOptions()
options.file_info = file_info
options.annotation_ids = [0,1,2,3,4,5,6,7,8,9,10,11]
# 出力ファイル
options.output_path = "output.docx"
# 削除リクエスト
request = groupdocs_annotation_cloud.RemoveAnnotationsRequest(options)
result = api.remove_annotations(request)
print("RemoveAnnotations: Annotations removed: " + result['href'])
出力ファイルをダウンロードする
上記のコード サンプルでは、注釈を削除した後、出力 DOCX ファイル (output.docx) をクラウドに保存します。次のコードサンプルを使用してダウンロードできます。
# APIインスタンス
file_api = groupdocs_annotation_cloud.FileApi.from_config(configuration)
# ファイルのダウンロードリクエスト
request = groupdocs_annotation_cloud.DownloadFileRequest("output.docx", my_storage)
response = file_api.download_file(request)
# ダウンロードしたファイルを作業ディレクトリに移動します
shutil.move(response, "C:\\Files\\")
オンラインで試す
上記の API を使用して開発された、次の無料のオンライン DOCX アノテーション ツールをお試しください。 https://products.groupdocs.app/annotation/docx
結論
この記事では、Python を使用してクラウド上の Word 文書から注釈を抽出または削除する方法を学習しました。また、プログラムによって DOCX ファイルをクラウドにアップロードし、クラウドからファイルをダウンロードする方法についても学習しました。 ドキュメント を使用すると、GroupDocs.Annotation Cloud API についてさらに詳しく学ぶことができます。また、ブラウザーを通じて API を直接視覚化して操作できる API リファレンス セクションも提供しています。不明な点がある場合は、フォーラム でお気軽にお問い合わせください。