Як розробник Python, ви можете програмно анотувати будь-який файл Word (.doc або .docx) у хмарі. Анотації зазвичай являють собою метадані у формі коментарів, приміток, пояснень або інших типів зовнішніх зауважень у документі, що надають додаткову інформацію про існуючу частину даних. У цій статті мова піде про те, як анотувати файли DOCX за допомогою REST API у Python.
У цій статті будуть розглянуті такі теми:
- Анотація документа REST API та Python SDK
- Анотуйте файли DOCX за допомогою REST API
- Додайте кілька анотацій за допомогою Python
Анотація документа REST API та Python SDK
Для анотування документів DOC або DOCX я буду використовувати API Python SDK GroupDocs.Annotation Cloud. Це дозволяє програмним шляхом створювати онлайн-інструменти анотування документів і зображень. Такі інструменти можна використовувати для додавання анотацій, накладень водяних знаків, замін тексту, редагування, наліпок і текстових розміток до ділових документів усіх популярних форматів. Він також надає .NET, Java, PHP, Ruby та Node.js SDK як члени сімейства анотацій документів для Cloud API.
Ви можете встановити GroupDocs.Annotation Cloud у свій проект Python за допомогою такої команди в консолі:
pip install groupdocs_annotation_cloud
Будь ласка, отримайте свій ідентифікатор клієнта та секретний ключ клієнта з інформаційної панелі, перш ніж почати виконувати кроки та доступні приклади коду. Додайте свій ідентифікатор і секрет у код, як показано нижче:
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"
Анотуйте файли DOCX за допомогою REST API у Python
Ви можете додати анотації до файлу DOCX, виконавши прості кроки, наведені нижче:
- Завантажте файл DOCX у хмару
- Додайте анотації до файлів DOCX у Python
- Завантажити оновлений файл
Завантажте документ
Перш за все, завантажте файл 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 буде доступний у розділі файлів вашої інформаційної панелі в хмарі.
Додайте анотації до файлів DOCX у Python
Щоб програмно вставити анотації в документ Word, виконайте наведені нижче дії.
- Створіть екземпляр AnnotationInfo
- Встановіть різні властивості анотації, наприклад положення, тип, текст тощо.
- Створіть екземпляр FileInfo
- Встановіть шлях до файлу
- Створіть екземпляр AnnotateOptions
- Установіть для інформації про файл значення AnnotateOptions
- Установіть для анотації значення AnnotateOptions
- Створіть запит, викликавши метод AnnotateRequest
- Отримайте результати, викликавши метод AnnotateApi.annotate().
У наведеному нижче фрагменті коду показано, як вставити анотації області в документ Word за допомогою 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
# Додати анотацію області
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)
У результаті анотації області буде вставлено в документ, як показано нижче.
Підтримувані типи анотацій
Нижче наведено список підтримуваних типів анотацій, які ви можете додати до своїх файлів 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().
У наведеному нижче фрагменті коду показано, як додати кілька анотацій до файлу DOCX за допомогою 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 = 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)
У результаті анотації зображення та водяного знака буде вставлено в документ, як показано нижче.
Висновок
У цій статті ви дізналися, як додавати різні типи анотацій до документів Word у хмарі за допомогою Document Annotation REST API за допомогою Python. Ви також дізналися, як програмно завантажити файл DOCX у хмару, а потім завантажити анотований файл із хмари. Ви можете дізнатися більше про GroupDocs.Annotation Cloud API за допомогою документації. Ми також надаємо розділ API Reference, який дозволяє візуалізувати наші API та взаємодіяти з ними безпосередньо через браузер. У разі будь-яких неясностей зв’яжіться з нами на форумі.