averbis-python-api
  • Welcome to the Averbis Python API documentation!
  • API Reference
    • DocumentCollection
      • DocumentCollection.create_and_run_process()
      • DocumentCollection.create_process()
      • DocumentCollection.delete()
      • DocumentCollection.delete_document()
      • DocumentCollection.export_json_document_stream()
      • DocumentCollection.get_number_of_documents()
      • DocumentCollection.get_process()
      • DocumentCollection.import_documents()
      • DocumentCollection.import_json_document_stream()
      • DocumentCollection.list_documents()
      • DocumentCollection.list_processes()
      • DocumentCollection.read_document_text()
    • EvaluationConfiguration
      • EvaluationConfiguration.add_feature()
      • EvaluationConfiguration.use_enclosing_annotation_partial_match()
      • EvaluationConfiguration.use_overlap_partial_match()
      • EvaluationConfiguration.use_range_variance_partial_match()
    • ExtendedRequestException
    • Pear
      • Pear.delete()
      • Pear.get_default_configuration()
    • Pipeline
      • Pipeline.STATE_STARTED
      • Pipeline.STATE_STARTING
      • Pipeline.STATE_STOPPED
      • Pipeline.STATE_STOPPING
      • Pipeline.analyse_cas_to_cas()
      • Pipeline.analyse_fhir()
      • Pipeline.analyse_fhir_to_cas()
      • Pipeline.analyse_fhir_to_fhir()
      • Pipeline.analyse_html()
      • Pipeline.analyse_pdf_to_fhir()
      • Pipeline.analyse_pdf_to_json()
      • Pipeline.analyse_pdf_to_pdf()
      • Pipeline.analyse_text()
      • Pipeline.analyse_text_to_cas()
      • Pipeline.analyse_text_to_fhir()
      • Pipeline.analyse_texts()
      • Pipeline.analyse_texts_to_cas()
      • Pipeline.analyse_texts_to_fhir()
      • Pipeline.collection_process_complete()
      • Pipeline.create_resource_container()
      • Pipeline.delete()
      • Pipeline.delete_resources()
      • Pipeline.download_resources()
      • Pipeline.ensure_started()
      • Pipeline.ensure_stopped()
      • Pipeline.get_configuration()
      • Pipeline.get_info()
      • Pipeline.get_type_system()
      • Pipeline.is_started()
      • Pipeline.list_resource_containers()
      • Pipeline.list_resources()
      • Pipeline.set_configuration()
      • Pipeline.start()
      • Pipeline.stop()
      • Pipeline.upload_resources()
      • Pipeline.wait_for_pipeline_to_arrive_at_state()
      • Pipeline.wait_for_pipeline_to_leave_transient_state()
    • Process
      • Process.ProcessState
      • Process.create_and_run_process()
      • Process.delete()
      • Process.evaluate_against()
      • Process.export_text_analysis()
      • Process.export_text_analysis_to_cas()
      • Process.get_process_state()
      • Process.import_text_analysis_result()
      • Process.process_unprocessed()
      • Process.rename()
      • Process.rerun()
    • Project
      • Project.classify_text()
      • Project.create_document_collection()
      • Project.create_pipeline()
      • Project.create_resource_container()
      • Project.create_terminology()
      • Project.delete()
      • Project.delete_pear()
      • Project.delete_resources()
      • Project.download_resources()
      • Project.exists_document_collection()
      • Project.exists_pipeline()
      • Project.get_document_collection()
      • Project.get_pipeline()
      • Project.get_terminology()
      • Project.install_pear()
      • Project.list_annotators()
      • Project.list_document_collections()
      • Project.list_pears()
      • Project.list_pipelines()
      • Project.list_processes()
      • Project.list_resource_containers()
      • Project.list_resources()
      • Project.list_terminologies()
      • Project.neural_search()
      • Project.search()
      • Project.upload_resources()
    • ResourceContainer
      • ResourceContainer.delete()
      • ResourceContainer.delete_resource()
      • ResourceContainer.export_resource()
      • ResourceContainer.export_resources()
      • ResourceContainer.list_resources()
      • ResourceContainer.upsert_resource()
    • Result
      • Result.successful()
    • Terminology
      • Terminology.EXPORT_STATE_ABORTED
      • Terminology.EXPORT_STATE_ABORTING
      • Terminology.EXPORT_STATE_COMPLETED
      • Terminology.EXPORT_STATE_FAILED
      • Terminology.EXPORT_STATE_PREPARING
      • Terminology.EXPORT_STATE_PROCESSING_EXPORT
      • Terminology.IMPORT_STATE_ABORTED
      • Terminology.IMPORT_STATE_ABORTING
      • Terminology.IMPORT_STATE_COMPLETED
      • Terminology.IMPORT_STATE_FAILED
      • Terminology.IMPORT_STATE_PREPARING
      • Terminology.IMPORT_STATE_PROCESSING_CONCEPTS
      • Terminology.IMPORT_STATE_PROCESSING_RELATIONS
      • Terminology.PENDING_EXPORT_STATES
      • Terminology.PENDING_IMPORT_STATES
      • Terminology.concept_autosuggest()
      • Terminology.delete()
      • Terminology.get_export_status()
      • Terminology.get_import_status()
      • Terminology.import_data()
      • Terminology.provision()
      • Terminology.start_export()
      • Terminology.start_import()
    • TextanalysisMode
      • TextanalysisMode.DO_NOTHING
      • TextanalysisMode.REMOVE_RESULTS
      • TextanalysisMode.TRIGGER_PROCESSES
    • Client
      • Client.__init__()
      • Client.change_password()
      • Client.create_project()
      • Client.create_resource_container()
      • Client.delete_resources()
      • Client.download_resources()
      • Client.ensure_available()
      • Client.exists_project()
      • Client.generate_api_token()
      • Client.get_api_token_status()
      • Client.get_build_info()
      • Client.get_project()
      • Client.get_spec_version()
      • Client.invalidate_api_token()
      • Client.list_projects()
      • Client.list_resource_containers()
      • Client.list_resources()
      • Client.regenerate_api_token()
      • Client.set_timeout()
      • Client.upload_resources()
    • Supported UIMA File Types
    • Evaluation process
      • Starting an evaluation process for exact matches of Diagnosis annotations
      • Trouble shooting the evaluation
averbis-python-api
  • Search


© Copyright 2021, Averbis GmbH.

Built with Sphinx using a theme provided by Read the Docs.