medkit.io.medkit_json.text#

Functions:

load_text_anns(input_file[, encoding])

Load text annotations from a medkit-json file generated with save_audio_anns()

load_text_document(input_file[, ...])

Load a text document from a medkit-json file generated with save_text_document().

load_text_documents(input_file[, encoding])

Load text documents from a medkit-json file generated with save_text_documents()

save_text_anns(anns, output_file[, encoding])

Save text annotations into a medkit-json file.

save_text_document(doc, output_file[, ...])

Save a text document into a medkit-json file.

save_text_documents(docs, output_file[, ...])

Save text documents into a medkit-json file.
load_text_document(input_file, anns_input_file=None, encoding='utf-8')[source]#

Load a text document from a medkit-json file generated with save_text_document().

Parameters

  • input_file (Union[str, Path]) – Path to the medkit-json file containing the document

  • anns_input_file (Union[str, Path, None]) – Optional medkit-json file containing separate annotations of the document.

  • encoding (Optional[str]) – Optional encoding of input_file and anns_input_file

Return type

TextDocument

Returns

TextDocument – The text document in the file

load_text_documents(input_file, encoding='utf-8')[source]#

Load text documents from a medkit-json file generated with save_text_documents()

Parameters

  • input_file (Union[str, Path]) – Path to the medkit-json file containing the documents

  • encoding (Optional[str]) – Optional encoding of input_file

Return type

Iterator[TextDocument]

Returns

Iterator[TextDocument] – An iterator to the text documents in the file

load_text_anns(input_file, encoding='utf-8')[source]#

Load text annotations from a medkit-json file generated with save_audio_anns()

Parameters

  • input_file (Union[str, Path]) – Path to the medkit-json file containing the annotations

  • encoding (Optional[str]) – Optional encoding of input_file

Return type

Iterator[TextAnnotation]

Returns

Iterator[TextAnnotation] – An iterator to the text annotations in the file

save_text_document(doc, output_file, split_anns=False, anns_output_file=None, encoding='utf-8')[source]#

Save a text document into a medkit-json file.

Parameters

  • doc (TextDocument) – The text document to save

  • output_file (Union[str, Path]) – Path of the generated medkit-json file

  • split_anns (bool) – If True, the annotations will be saved in a separate medkit-json file instead of being included in the main document file

  • anns_output_file (Union[str, Path, None]) – Path of the medkit-json file storing the annotations if split_anns is True. If not provided, output_file will be used with an extra “_anns” suffix.

  • encoding (Optional[str]) – Optional encoding of output_file and anns_output_file

save_text_documents(docs, output_file, encoding='utf-8')[source]#

Save text documents into a medkit-json file.

Parameters

  • docs (Iterable[TextDocument]) – The text documents to save

  • output_file (Union[str, Path]) – Path of the generated medkit-json file

  • encoding (Optional[str]) – Optional encoding of output_file

save_text_anns(anns, output_file, encoding='utf-8')[source]#

Save text annotations into a medkit-json file.

Parameters

  • docs – The text annotations to save

  • output_file (Union[str, Path]) – Path of the generated medkit-json file

  • encoding (Optional[str]) – Optional encoding of output_file