In qualità di sviluppatore Python, puoi annotare qualsiasi file Word (.doc o .docx) a livello di codice sul cloud. Le annotazioni di solito sono metadati sotto forma di commenti, note, spiegazioni o altri tipi di osservazioni esterne nel documento che forniscono informazioni aggiuntive su un dato esistente. Questo articolo si concentrerà su come annotare i file DOCX utilizzando un’API REST in Python.

In questo articolo saranno trattati i seguenti argomenti:

API REST di annotazione del documento e SDK Python

GroupDocs.Annotation Cloud

Per annotare i documenti DOC o DOCX, utilizzerò l’API Python SDK of GroupDocs.Annotation Cloud. Ti consente di creare in modo programmatico strumenti di annotazione di documenti e immagini online. Tali strumenti possono essere utilizzati per aggiungere annotazioni, sovrapposizioni di filigrane, sostituzioni di testo, redazioni, note adesive e contrassegni di testo ai documenti aziendali di tutti i formati più diffusi. Fornisce inoltre SDK .NET, Java, PHP, Ruby e Node.js come document annotation family members per l’API Cloud.

Puoi installare GroupDocs.Annotation Cloud nel tuo progetto Python utilizzando il seguente comando nella console:

pip install groupdocs_annotation_cloud

Si prega di ottenere l’ID cliente e il segreto cliente dalla dashboard prima di iniziare a seguire i passaggi e gli esempi di codice disponibili. Aggiungi il tuo ID e segreto nel codice come mostrato di seguito:

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"

Annota i file DOCX utilizzando un’API REST in Python

Puoi aggiungere annotazioni al file DOCX seguendo i semplici passaggi indicati di seguito:

Carica il documento

Prima di tutto, carica il file DOCX sul Cloud utilizzando l’esempio di codice riportato di seguito:

# Crea un'istanza dell'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)

Di conseguenza, il file DOCX caricato sarà disponibile nella sezione file della dashboard sul cloud.

Aggiungi annotazioni ai file DOCX in Python

Si prega di seguire i passaggi indicati di seguito per inserire annotazioni nel documento di Word a livello di codice.

  • Crea un’istanza di AnnotationInfo
  • Imposta varie proprietà di annotazione, ad esempio posizione, tipo, testo, ecc.
  • Crea un’istanza di FileInfo
  • Imposta il percorso del file
  • Crea un’istanza di AnnotateOptions
  • Imposta le informazioni sul file su AnnotateOptions
  • Imposta l’annotazione su AnnotateOptions
  • Crea una richiesta chiamando il metodo AnnotateRequest
  • Ottieni risultati chiamando il metodo AnnotateApi.annotate()

Il frammento di codice seguente mostra come inserire annotazioni di area nel documento di Word usando un’API REST.

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

# Aggiungi annotazione 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)

Di conseguenza, le annotazioni dell’area verranno inserite nel documento come mostrato di seguito.

Aggiungi annotazioni ai file DOCX in Python

Tipi di annotazioni supportati

Di seguito trovi l’elenco dei tipi di annotazioni supportati, che puoi aggiungere ai tuoi file DOCX seguendo i passaggi menzionati in precedenza:

  • La zona
  • Distanza
  • Collegamento
  • Punto
  • Polilinea
  • Immagine
  • Testo
  • Filigrana
  • Freccia

Scarica il file aggiornato

L’esempio di codice precedente salverà il file DOCX con annotazioni nel cloud. Puoi scaricarlo utilizzando il seguente esempio di codice:

# Crea un'istanza dell'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)

# Sposta il file scaricato nella tua directory di lavoro
shutil.move(response, "C:\\Files\\")

Aggiungi più annotazioni usando Python

Segui i passaggi indicati di seguito per aggiungere più annotazioni ai tuoi file DOCX a livello di codice.

  • Crea la prima istanza di AnnotationInfo
  • Imposta varie proprietà di annotazione per la prima istanza, ad esempio posizione, tipo, testo, ecc.
  • Crea una seconda istanza di AnnotationInfo
  • Imposta varie proprietà di annotazione per la seconda istanza, ad esempio posizione, tipo, testo, ecc.
  • Crea un’istanza di FileInfo
  • Imposta il percorso del file
  • Crea un’istanza di AnnotateOptions
  • Imposta le informazioni sul file su AnnotateOptions
  • Imposta la prima e la seconda annotazione su AnnotateOptions
  • Crea una richiesta chiamando il metodo AnnotateRequest
  • Ottieni risultati chiamando il metodo AnnotateApi.annotate()

Il seguente frammento di codice mostra come aggiungere più annotazioni al file DOCX utilizzando un’API REST. Si prega di seguire i passaggi menzionati in precedenza per caricare e scaricare un 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)

Di conseguenza, le annotazioni dell’immagine e della filigrana verranno inserite nel documento come mostrato di seguito.

annotazioni di immagini e filigrane

Conclusione

In questo articolo, hai imparato come aggiungere vari tipi di annotazioni ai documenti di Word sul cloud con l’API REST di annotazione del documento utilizzando Python. Hai anche imparato come caricare a livello di codice il file DOCX sul cloud e quindi scaricare il file annotato dal cloud. Puoi saperne di più su GroupDocs.Annotation Cloud API utilizzando la documentazione. Forniamo anche una sezione Riferimento API che ti consente di visualizzare e interagire con le nostre API direttamente attraverso il browser. In caso di ambiguità, non esitate a contattarci sul forum.