Module phc.easy.ocr

class Ocr:
    Config = Config
    Suggestion = Suggestion
    Document = Document
    DocumentComposition = DocumentComposition
    Block = Block

    @staticmethod
    def upload(
        source: str, folder="ocr-uploads", auth_args: Auth = Auth.shared()
    ):
        """Upload a file from a path to the ocr directory (defaults to 'ocr-uploads')"""
        auth = Auth(auth_args)
        files = Files(auth.session())
        filename = source.split("/")[-1]

        return files.upload(
            auth.project_id, source, file_name=f"/{folder}/{filename}"
        ).data

    @staticmethod
    def upload_and_run(
        source: str,
        folder="ocr-uploads",
        auth_args: Auth = Auth.shared(),
        **document_kw_args,
    ):
        """Upload a document and run PrecisionOCR

        Returns the DocumentReference
        """
        auth = Auth(auth_args)

        file_id = Ocr.upload(source, folder=folder, auth_args=auth)["id"]
        return Ocr.run(file_id, auth_args=auth, **document_kw_args)

    @staticmethod
    def run(
        file_id: str,
        auth_args: Auth = Auth.shared(),
        pause_time=1,
        **document_kw_args,
    ):
        """Run PrecisionOCR on a specific file id

        Returns the DocumentReference
        """
        auth = Auth(auth_args)
        client = BaseClient(auth.session())

        response = client._api_call(
            "ocr/documents",
            json={"project": auth.project_id, "fileId": file_id},
        )

        document_reference_id = response.data["documentReferenceId"]

        # Unfortunately, we just have to wait for it to be in FSS
        sleep(pause_time)

        return Document.get(
            id=document_reference_id, auth_args=auth_args, **document_kw_args
        )

Class variables

var Block

var Config

var Document

Provides an abstract class and/or static methods for retrieving items from a FSS table that relates to a patient

var DocumentComposition

Provides an abstract class and/or static methods for retrieving items from a FSS table that relates to a patient

var Suggestion

Provides an abstract class and/or static methods for retrieving items from a FSS table that relates to a patient

Static methods

def run(file_id: str, auth_args: Auth = <phc.easy.auth.Auth object>, pause_time=1, **document_kw_args)

Run PrecisionOCR on a specific file id

Returns the DocumentReference

Expand source code

@staticmethod
def run(
    file_id: str,
    auth_args: Auth = Auth.shared(),
    pause_time=1,
    **document_kw_args,
):
    """Run PrecisionOCR on a specific file id

    Returns the DocumentReference
    """
    auth = Auth(auth_args)
    client = BaseClient(auth.session())

    response = client._api_call(
        "ocr/documents",
        json={"project": auth.project_id, "fileId": file_id},
    )

    document_reference_id = response.data["documentReferenceId"]

    # Unfortunately, we just have to wait for it to be in FSS
    sleep(pause_time)

    return Document.get(
        id=document_reference_id, auth_args=auth_args, **document_kw_args
    )

def upload(source: str, folder='ocr-uploads', auth_args: Auth = <phc.easy.auth.Auth object>)

Upload a file from a path to the ocr directory (defaults to 'ocr-uploads')

Expand source code

@staticmethod
def upload(
    source: str, folder="ocr-uploads", auth_args: Auth = Auth.shared()
):
    """Upload a file from a path to the ocr directory (defaults to 'ocr-uploads')"""
    auth = Auth(auth_args)
    files = Files(auth.session())
    filename = source.split("/")[-1]

    return files.upload(
        auth.project_id, source, file_name=f"/{folder}/{filename}"
    ).data

def upload_and_run(source: str, folder='ocr-uploads', auth_args: Auth = <phc.easy.auth.Auth object>, **document_kw_args)

Upload a document and run PrecisionOCR

Returns the DocumentReference

Expand source code

@staticmethod
def upload_and_run(
    source: str,
    folder="ocr-uploads",
    auth_args: Auth = Auth.shared(),
    **document_kw_args,
):
    """Upload a document and run PrecisionOCR

    Returns the DocumentReference
    """
    auth = Auth(auth_args)

    file_id = Ocr.upload(source, folder=folder, auth_args=auth)["id"]
    return Ocr.run(file_id, auth_args=auth, **document_kw_args)