API Reference

• Catalog
  • Catalog
    • Catalog.search()
    • Catalog.interactive_search()
• Authentication
  • Authentication
    • Authentication.init()
    • Authentication.from_json()
    • Authentication.create_authentication_url()
    • Authentication.from_success_code()
    • Authentication.create()
    • Authentication.refresh()
    • Authentication.refresh_if_needed()
    • Authentication.to_json()
  • NeedAuthentication
  • need_authentication()
• Entity
  • Entity
    • Entity.from_search_result()
    • Entity.from_id()
• Corpus
  • Licence
  • Distribution
    • Distribution.from_data()
    • Distribution.is_downloadable()
  • Corpus
    • Corpus.from_id()
    • Corpus.from_entity()
    • Corpus.download()
• Service
  • Service
    • Service.from_id()
    • Service.from_entity()
    • Service.from_local_installation()
    • Service.__call__()
• Benchmark
  • Benchmark
    • Benchmark.from_entities()
    • Benchmark.from_ids()
    • Benchmark.__call__()
  • BenchmarkResult
    • BenchmarkResult.set_colwidth()
    • BenchmarkResult.compare()
    • BenchmarkResult.compare_results()
    • BenchmarkResult.compare_response_times()
• Pipeline
  • Pipeline
    • Pipeline.from_entities()
    • Pipeline.from_ids()
    • Pipeline.__call__()
• FlaskService
  • FlaskService
    • FlaskService.to_json()
    • FlaskService.run()
    • FlaskService.url_param()
    • FlaskService.process()
    • FlaskService.process_request()
    • FlaskService.process_text()
    • FlaskService.process_structured_text()
    • FlaskService.process_audio()
    • FlaskService.process_image()
    • FlaskService.create_requirements()
    • FlaskService.create_docker_files()
    • FlaskService.docker_build_image()
    • FlaskService.docker_push_image()
• QuartService
  • QuartService
    • QuartService.to_json()
    • QuartService.run()
    • QuartService.setup()
    • QuartService.shutdown()
    • QuartService.url_param()
    • QuartService.process()
    • QuartService.process_request()
    • QuartService.process_text()
    • QuartService.process_structured_text()
    • QuartService.process_audio()
    • QuartService.process_image()
    • QuartService.create_requirements()
    • QuartService.create_docker_files()
    • QuartService.docker_build_image()
    • QuartService.docker_push_image()
• LT Service Local Installation
  • LTServiceLocalInstallation
    • LTServiceLocalInstallation.from_id()
    • LTServiceLocalInstallation.from_docker_image()
• Local Installation
  • LocalInstallation
    • LocalInstallation.from_ids()
    • LocalInstallation.create_docker_compose()
• Model
  • Base messages
    • Request
      • Request
        • Request.type
        • Request.params
        • Request.json()
    • Response
      • ResponseObject
        • ResponseObject.type
        • ResponseObject.warnings
        • ResponseObject.json()
    • Annotation
      • Annotation
        • Annotation.start
        • Annotation.end
        • Annotation.source_start
        • Annotation.source_end
        • Annotation.features
        • Annotation.json()
    • Failure
      • Failure
        • Failure.errors
        • Failure.json()
    • Progress
      • Progress
        • Progress.percent
        • Progress.message
        • Progress.json()
    • StatusMessages
      • StatusMessage
        • StatusMessage.code
        • StatusMessage.params
        • StatusMessage.text
        • StatusMessage.detail
        • StatusMessage.json()
    • StandardMessages
      • StandardMessages
        • StandardMessages.generate_elg_request_invalid()
        • StandardMessages.generate_elg_request_missing()
        • StandardMessages.generate_elg_request_type_unsupported()
        • StandardMessages.generate_elg_request_property_unsupported()
        • StandardMessages.generate_elg_request_too_large()
        • StandardMessages.generate_elg_request_parameter_missing()
        • StandardMessages.generate_elg_request_parameter_invalid()
        • StandardMessages.generate_elg_request_text_mimetype_unsupported()
        • StandardMessages.generate_elg_request_audio_format_unsupported()
        • StandardMessages.generate_elg_request_audio_samplerate_unsupported()
        • StandardMessages.generate_elg_request_image_format_unsupported()
        • StandardMessages.generate_elg_request_structuredtext_property_unsupported()
        • StandardMessages.generate_elg_response_invalid()
        • StandardMessages.generate_elg_response_type_unsupported()
        • StandardMessages.generate_elg_response_property_unsupported()
        • StandardMessages.generate_elg_response_texts_property_unsupported()
        • StandardMessages.generate_elg_response_classification_property_unsupported()
        • StandardMessages.generate_elg_service_not_found()
        • StandardMessages.generate_elg_async_call_not_found()
        • StandardMessages.generate_elg_permissions_quotaexceeded()
        • StandardMessages.generate_elg_permissions_accessdenied()
        • StandardMessages.generate_elg_permissions_accessmanagererror()
        • StandardMessages.generate_elg_file_not_found()
        • StandardMessages.generate_elg_file_expired()
        • StandardMessages.generate_elg_upload_too_large()
        • StandardMessages.generate_elg_service_internalerror()
  • Request messages
    • TextRequest
      • TextRequest
        • TextRequest.type
        • TextRequest.content
        • TextRequest.mimeType
        • TextRequest.features
        • TextRequest.annotations
    • Structured Text Request
      • Text
        • Text.content
        • Text.mime_type
        • Text.features
        • Text.annotations
        • Text.texts
        • Text.either_content_or_text()
        • Text.json()
      • StructuredTextRequest
        • StructuredTextRequest.type
        • StructuredTextRequest.texts
    • Audio Request
      • AudioRequest
        • AudioRequest.type
        • AudioRequest.content
        • AudioRequest.generator
        • AudioRequest.format
        • AudioRequest.sample_rate
        • AudioRequest.features
        • AudioRequest.annotations
        • AudioRequest.format_must_be_specific()
        • AudioRequest.generator_must_be_iterable()
        • AudioRequest.from_file()
    • Image Request
      • ImageRequest
        • ImageRequest.type
        • ImageRequest.content
        • ImageRequest.generator
        • ImageRequest.format
        • ImageRequest.features
        • ImageRequest.format_must_be_valid()
        • ImageRequest.generator_must_be_iterable()
        • ImageRequest.from_file()
  • Response messages
    • AnnotationsResponse
      • AnnotationsResponse
        • AnnotationsResponse.type
        • AnnotationsResponse.features
        • AnnotationsResponse.annotations
        • AnnotationsResponse.either_features_or_annotations()
    • AudioResponse
      • AudioResponse
        • AudioResponse.type
        • AudioResponse.content
        • AudioResponse.format
        • AudioResponse.features
        • AudioResponse.annotations
        • AudioResponse.format_must_be_specific()
        • AudioResponse.to_file()
    • Classification Response
      • ClassesResponse
        • ClassesResponse.class_field
        • ClassesResponse.score
        • ClassesResponse.json()
      • ClassificationResponse
        • ClassificationResponse.type
        • ClassificationResponse.classes
    • TextsResponse
      • TextsResponseObject
        • TextsResponseObject.role
        • TextsResponseObject.content
        • TextsResponseObject.texts
        • TextsResponseObject.score
        • TextsResponseObject.features
        • TextsResponseObject.annotations
        • TextsResponseObject.either_content_or_text()
        • TextsResponseObject.json()
      • TextsResponse
        • TextsResponse.type
        • TextsResponse.texts