Sebagai pengembang Python, Anda dapat membuat anotasi file Word (.doc atau .docx) apa pun secara terprogram di cloud. Anotasi biasanya adalah metadata dalam bentuk komentar, catatan, penjelasan, atau jenis komentar eksternal lainnya dalam dokumen yang memberikan informasi tambahan tentang data yang ada. Artikel ini akan berfokus pada cara membuat anotasi file DOCX menggunakan REST API dengan Python.
Topik-topik berikut akan dibahas dalam artikel ini:
- Dokumen Anotasi REST API dan Python SDK
- Anotasi File DOCX menggunakan REST API
- Tambahkan Banyak Anotasi menggunakan Python
Dokumen Anotasi REST API dan Python SDK
Untuk menganotasi dokumen DOC atau DOCX, saya akan menggunakan Python SDK of GroupDocs.Annotation Cloud API. Ini memungkinkan Anda untuk secara terprogram membuat dokumen online dan alat anotasi gambar. Alat semacam itu dapat digunakan untuk menambahkan anotasi, overlay tanda air, penggantian teks, redaksi, catatan tempel, dan markup teks ke dokumen bisnis dari semua format populer. Ini juga menyediakan SDK .NET, Java, PHP, Ruby, dan Node.js sebagai anggota keluarga anotasi dokumen untuk Cloud API.
Anda dapat menginstal GroupDocs.Annotation Cloud ke proyek Python Anda menggunakan perintah berikut di konsol:
pip install groupdocs_annotation_cloud
Dapatkan ID Klien dan Rahasia Klien Anda dari dashboard sebelum Anda mulai mengikuti langkah-langkah dan contoh kode yang tersedia. Tambahkan ID dan rahasia Anda dalam kode seperti yang ditunjukkan di bawah ini:
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"
Anotasi File DOCX menggunakan REST API dengan Python
Anda dapat menambahkan anotasi ke file DOCX dengan mengikuti langkah-langkah sederhana yang disebutkan di bawah ini:
- Unggah file DOCX ke Cloud
- Tambahkan Anotasi ke File DOCX dengan Python
- Unduh file yang diperbarui
Unggah Dokumen
Pertama-tama, unggah file DOCX ke Cloud menggunakan contoh kode di bawah ini:
# Buat instance 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)
Akibatnya, file DOCX yang diunggah akan tersedia di bagian file dasbor Anda di cloud.
Tambahkan Anotasi ke File DOCX dengan Python
Silakan ikuti langkah-langkah yang disebutkan di bawah ini untuk menyisipkan anotasi dalam dokumen Word secara terprogram.
- Buat instance AnnotationInfo
- Atur berbagai properti Anotasi misalnya posisi, jenis, teks, dll.
- Buat instance FileInfo
- Tetapkan jalur file
- Buat instance dari AnnotateOptions
- Setel info file ke AnnotateOptions
- Setel anotasi ke AnnotateOptions
- Buat permintaan dengan memanggil metode AnnotateRequest
- Dapatkan hasil dengan memanggil metode AnnotateApi.annotate()
Cuplikan kode berikut menunjukkan cara menyisipkan anotasi area di dokumen Word menggunakan REST API.
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
# Tambahkan Anotasi Area
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)
Akibatnya, anotasi area akan dimasukkan ke dalam dokumen seperti yang ditunjukkan di bawah ini.
Jenis Anotasi yang Didukung
Temukan di bawah daftar jenis anotasi yang didukung, Anda dapat menambahkan ke file DOCX Anda dengan mengikuti langkah-langkah yang disebutkan sebelumnya:
- Daerah
- Jarak
- Tautan
- Titik
- Polilin
- Gambar
- Teks
- Tanda air
- Anak panah
Unduh File yang Diperbarui
Contoh kode di atas akan menyimpan file DOCX beranotasi di cloud. Anda dapat mengunduhnya menggunakan contoh kode berikut:
# Buat instance 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)
# Pindahkan file yang diunduh ke direktori kerja Anda
shutil.move(response, "C:\\Files\\")
Tambahkan Banyak Anotasi menggunakan Python
Silakan ikuti langkah-langkah yang disebutkan di bawah ini untuk menambahkan beberapa anotasi ke file DOCX Anda secara terprogram.
- Buat instance pertama dari AnnotationInfo
- Setel berbagai properti Anotasi untuk contoh pertama misalnya posisi, jenis, teks, dll.
- Buat instance kedua AnnotationInfo
- Tetapkan berbagai properti anotasi untuk contoh kedua misalnya posisi, jenis, teks, dll.
- Buat instance FileInfo
- Tetapkan jalur file
- Buat instance dari AnnotateOptions
- Setel info file ke AnnotateOptions
- Tetapkan anotasi pertama dan kedua ke AnnotateOptions
- Buat permintaan dengan memanggil metode AnnotateRequest
- Dapatkan hasil dengan memanggil metode AnnotateApi.annotate()
Cuplikan kode berikut menunjukkan cara menambahkan beberapa anotasi ke file DOCX menggunakan REST API. Silakan ikuti langkah-langkah yang disebutkan sebelumnya untuk mengunggah dan mengunduh file.
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)
Akibatnya, anotasi gambar dan tanda air akan disisipkan dalam dokumen seperti yang ditunjukkan di bawah ini.
Kesimpulan
Pada artikel ini, Anda telah mempelajari cara menambahkan berbagai jenis anotasi ke dokumen Word di cloud dengan Document Annotation REST API menggunakan Python. Anda juga mempelajari cara mengunggah file DOCX secara terprogram di cloud dan kemudian mengunduh file beranotasi dari cloud. Anda dapat mempelajari lebih lanjut tentang GroupDocs.Annotation Cloud API menggunakan dokumentasi. Kami juga menyediakan bagian Referensi API yang memungkinkan Anda memvisualisasikan dan berinteraksi dengan API kami secara langsung melalui browser. Jika ada ambiguitas, jangan ragu untuk menghubungi kami di forum.