Averbis Python API 0.17.0

What's Changed

• Issue #218: Support for streaming export and import APIs by @rec-averbis in #222
• Issue #215: Support neuralSearch endpoint and enable searchable chunks by @viorell91 in #216
• Issue #217: Ability to inject meta_data using pipeline.analyze_text_to_cas by @viorell91 in #220
• Issue #224: Implement a collection.read_document based on the export API by @rec-averbis in #225

New Contributors

• @viorell91 made their first contribution in #216

Full Changelog: 0.16.0...0.17.0

Averbis Python API 0.16.0

What's Changed

• Issue #210: Mark processes for search by @UWinch in #211
• Issue #212: Create method: analyse_pdf_to_fhir by @Theresa93 in #213
• Bugfix #208: Fix publish release workflow by @UWinch in #209

Full Changelog: 0.15.0...0.16.0

Averbis Python API 0.15.0

Python version

Python 3.8 is no longer supported. The minimal supported python version is now 3.9.

What's Changed

• Issue #188: Support multi-doc json import by @UWinch in #189
• Issue #198: Switch to uv and taskipy for build by @rec-averbis in #199
• Issue #171: Support reprocess unprocessed by @UWinch in #192
• Issue #190: Support textanalysisMode when importing documents by @UWinch in #191
• Issue #193: Reprocess only some documents of a process by @UWinch in #197
• Issue #194: Return status code with requestexception by @Theresa93 in #200
• Issue #204: Export selected documents' textanalysis results by @UWinch in #206
• Issue #201: Bump minimal Python version to 3.9 by @rec-averbis in #202

New Contributors

• @Theresa93 made their first contribution in #200

Full Changelog: 0.14.0...0.15.0

Averbis Python API 0.14.0

What's Changed

• Issue #181: Run tests on pull requests by @rec-averbis in #182
• Issue #179: Creating a client with credentials without checking first if the product is running by @rec-averbis in #180
• Issue #174: Support document import in json format by @UWinch in #176
• Issue #166: Enable FHIR response for analyze_text endpoint by @UWinch in #172
• Issue #173: Support metadata for analyseText by @UWinch in #184

Full Changelog: 0.13.0...0.14.0

Averbis Python API 0.13.0

We are happy to announce release 0.13.0 of the Averbis Python API. This release adds a new terminology endpoint conceptAutosuggest that allows for querying terminologies and introduces a new way of handling additional resources in the Health Discovery.

What's Changed

• Issue #164: Support new resource API by @UWinch in #165
• Issue #167: Add conceptAutosuggest by @DavidHuebner and @pdaumke-averbis in #168

Full Changelog: 0.12.0...0.13.0

Averbis Python API 0.12.0

We are happy to announce release 0.12.0 of the Averbis Python API. This release introduces new features such as annotator listings, experimental PDF analysis, and document deletion from a collection, along with a new endpoint for uploading license files. Additionally, it resolves an evaluation process bug and updates compatibility to support Python 3.12, dropping support for Python 3.6 and 3.7.

What's Changed

• Issue #152: List annotators by @UWinch in #153
• Issue #154: Evaluation fails when calling _ensure_process_created by @DavidHuebner in #155
• Issue #156: Support analysing pdf by @UWinch in #157
• Issue #159: Support for Python 3.12+ & Drop Support for Python 3.6 & Python 3.7 by @DavidHuebner in #160
• Issue #158: Add support for document deletion endpoint by @UWinch in #162
• Issue #161: Add endpoint for uploading license file by @UWinch in #163

Full Changelog: 0.11.0...0.12.0

Averbis Python API 0.11.0

What's Changed

With the latest release 0.11.0, one can configure via the Averbis Python API which annotation types are saved for each process.

• Issue #147: Support for annotation_types parameter in create_process … by @DavidHuebner in #148
• Issue #149: Support for lists in annotation types parameter by @DavidHuebner in #150

Full Changelog: 0.10.0...0.11.0

Averbis Python API 0.10.0

Averbis Python API 0.10.0

The main focus in this release is improving the document export speed together with providing new end points for renaming processes, usability and documentation improvements.

What's Changed

• Issue #127: rename process by @UWinch in #128
• Issue #129: Run tests against all Python versions 3.6 - 3.11. by @DavidHuebner in #130
• Issue #131: Speed up exporting processes via export document by @UWinch in #132
• Issue #139: Normalize URL in Client by @DavidHuebner in #140
• Issue #134: Export as CAS: only get document id if really necessary by @UWinch in #135
• Issue #143: Option to set arbitrary config params in the EvaluationCo… by @DavidHuebner in #144
• Issue #141: Get document typesystem by name instead of id by @UWinch in #142
• Issue #137: Document evaluation API endpoint by @UWinch in #138
• Issue #133: Support type filter for exporting as CAS by @UWinch in #136

Full Changelog: 0.9.0...0.10.0

Averbis Python API 0.9.0

We are happy to announce release 0.9.0 of the Averbis Python API.

Evaluation API Support

We now provide experimental support for evaluating text analysis results using the Averbis Python API. If you have two processes, let's say one gold_process containing an annotated dataset, and a second process that is the result of processing the documents from the same dataset with a pipeline (e.g. discharge_process), then you can compare the created annotations. In a simple scenario, one compares the spans of all Diagnosis annotations with the following code snippet.

eval_config = EvaluationConfiguration("de.averbis.types.health.Diagnosis", ["begin", "end"])
eval_process: Process = discharge_process.evaluate_against(gold_process,
                                                        process_name=f"{collection_name}-discharge-eval",
                                                        evaluation_configurations=[eval_config])

One can then download the results of the eval_process and proceed, e.g. by computing metrics over the whole dataset or by inspecting differences in the annotations. It is also possible to configure the EvaluationConfiguration to compare specific features or using different matching_criteria (e.g. OVERLAP_MATCH) using eval_config.use_overlap_partial_match(). The Evaluation API is avaiable in Health-Discovery version >= 6.11.0.

What's Changed

• Issue #121: Update URL for list_projects by @UWinch in #124
• Issue #120: Compare results of textanalysis processes by @UWinch in #122
• Issue #123 add flag exist ok when creating project by @DavidHuebner in #125

Full Changelog: 0.8.0...0.9.0

Averbis Python API 0.8.0

We are happy to release a new Python API version.

What's Changed

• Feature #103: Support calls to addTextAnalysisResult and updateTextAnalysisResult by @UWinch in #111
• Feature #110: Add support for the analyzeCasToCas endpoint by @reckart in #112
• Bugfix #115 analyse texts to cas returns results only after all data has been processed by @DavidHuebner in #116
• Bugfix #118: Require filename to be provided in import_documents for str by @DavidHuebner in #119

Full Changelog: 0.7.0...0.8.0