Jako vývojář Pythonu můžete v cloudu programově anotovat jakýkoli soubor Wordu (.doc nebo .docx). Anotace jsou obvykle metadata ve formě komentářů, poznámek, vysvětlení nebo jiných typů externích poznámek v dokumentu, které poskytují další informace o existující části dat. Tento článek se zaměří na to, jak anotovat soubory DOCX pomocí REST API v Pythonu.
Tento článek bude obsahovat následující témata:
- Anotace dokumentu REST API a Python SDK
- Anotace souborů DOCX pomocí REST API
- Přidejte více anotací pomocí Pythonu
Anotace dokumentu REST API a Python SDK
Pro anotování dokumentů DOC nebo DOCX budu používat Python SDK of GroupDocs.Annotation Cloud API. Umožňuje vám programově vytvářet online nástroje pro anotaci dokumentů a obrázků. Tyto nástroje lze použít k přidávání anotací, překryvných vodoznaků, nahrazování textu, redigování, poznámek a textových označení do obchodních dokumentů všech oblíbených formátů. Poskytuje také .NET, Java, PHP, Ruby a Node.js SDK jako členové rodiny anotací dokumentu pro Cloud API.
GroupDocs.Annotation Cloud můžete nainstalovat do svého projektu Python pomocí následujícího příkazu v konzole:
pip install groupdocs_annotation_cloud
Než začnete postupovat podle kroků a dostupných příkladů kódu, získejte své ID klienta a tajný klíč klienta z dashboard. Přidejte své ID a tajemství do kódu, jak je ukázáno níže:
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"
Anotace souborů DOCX pomocí REST API v Pythonu
Do souboru DOCX můžete přidat anotace podle jednoduchých kroků uvedených níže:
- Nahrajte soubor DOCX do cloudu
- Přidat poznámky k souborům DOCX v Pythonu
- Stáhnout aktualizovaný soubor
Nahrajte dokument
Nejprve nahrajte soubor DOCX do cloudu pomocí níže uvedeného příkladu kódu:
# Vytvořte instanci rozhraní 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)
V důsledku toho bude nahraný soubor DOCX dostupný v sekce souborů vašeho řídicího panelu v cloudu.
Přidejte poznámky k souborům DOCX v Pythonu
Chcete-li programově vložit poznámky do dokumentu aplikace Word, postupujte podle níže uvedených kroků.
- Vytvořte instanci AnnotationInfo
- Nastavte různé vlastnosti anotace, např. pozici, typ, text atd.
- Vytvořte instanci FileInfo
- Nastavte cestu k souboru
- Vytvořte instanci AnnotateOptions
- Nastavte informace o souboru na AnnotateOptions
- Nastavte anotaci na AnnotateOptions
- Vytvořte požadavek voláním metody AnnotateRequest
- Výsledky získáte voláním metody AnnotateApi.annotate().
Následující fragment kódu ukazuje, jak vložit poznámky oblasti do dokumentu aplikace Word pomocí rozhraní 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
# Přidat anotaci oblasti
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)
V důsledku toho budou popisy oblastí vloženy do dokumentu, jak je znázorněno níže.
Podporované typy anotací
Níže naleznete seznam podporovaných typů anotací, které můžete přidat do souborů DOCX podle výše uvedených kroků:
- Plocha
- Vzdálenost
- Odkaz
- Směřovat
- Polyline
- obraz
- Text
- Vodoznak
- Šipka
Stáhněte si aktualizovaný soubor
Výše uvedená ukázka kódu uloží anotovaný soubor DOCX do cloudu. Můžete si jej stáhnout pomocí následující ukázky kódu:
# Vytvořte instanci rozhraní 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)
# Přesuňte stažený soubor do svého pracovního adresáře
shutil.move(response, "C:\\Files\\")
Přidejte více anotací pomocí Pythonu
Chcete-li do souborů DOCX programově přidat více anotací, postupujte podle níže uvedených kroků.
- Vytvořte první instanci AnnotationInfo
- Nastavte různé vlastnosti Anotace pro první instanci, např. pozici, typ, text atd.
- Vytvořte druhou instanci AnnotationInfo
- Nastavte různé vlastnosti anotace pro druhou instanci, např. pozici, typ, text atd.
- Vytvořte instanci FileInfo
- Nastavte cestu k souboru
- Vytvořte instanci AnnotateOptions
- Nastavte informace o souboru na AnnotateOptions
- Nastavte první a druhou anotaci na AnnotateOptions
- Vytvořte požadavek voláním metody AnnotateRequest
- Výsledky získáte voláním metody AnnotateApi.annotate().
Následující fragment kódu ukazuje, jak přidat více anotací do souboru DOCX pomocí REST API. Chcete-li nahrát a stáhnout soubor, postupujte podle výše uvedených kroků.
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)
V důsledku toho budou obrázky a anotace vodoznaku vloženy do dokumentu, jak je znázorněno níže.
Závěr
V tomto článku jste se naučili přidávat různé typy anotací do dokumentů Wordu v cloudu pomocí REST API pro anotace dokumentů pomocí Pythonu. Také jste se naučili, jak programově nahrát soubor DOCX do cloudu a poté stáhnout soubor s poznámkami z cloudu. Více o GroupDocs.Annotation Cloud API se můžete dozvědět pomocí dokumentace. Poskytujeme také sekci API Reference, která vám umožní vizualizovat a pracovat s našimi API přímo prostřednictvím prohlížeče. V případě jakýchkoliv nejasností nás prosím neváhejte kontaktovat na fóru.