Confidence Functions

extracted_is_sure

extracted_is_sure(value_obj)

Returns true if the given Value does not contain characters

that are marked as "unsure" by OCR within the original text.



Args:

    value_obj (Value): The provenance-tracked result from some

                       extraction process.



Returns:

    True if the given Value does not contain characters

    that are marked as "unsure" by OCR within the original text,

    and False otherwise (as a Value-wrapped object).



Examples:

    extracted_is_sure(value) -> Value(True)

extracted_sureness_above

extracted_sureness_above(value_obj, percentage)

Returns True if the given Value contains a percentage of

sure characters greater than or equal to the given percentage.



Args:

    value_obj (Value): The provenance-tracked result from some

                       extraction process.

    percentage (Value[float]): A threshold from 0.0 to 1.0 which

                               indicates the threshold for how many

                               characters can be unsure.



Returns:

    True if the given Value contains a percentage of

    sure characters greater than or equal to the given percentage,

    and False otherwise (as a Value-wrapped object).



Examples:

    extracted_sureness_above(value) -> Value(False)

information_is_sure

information_is_sure(value_obj)

Returns true if the given Value was extracted without using characters

that are marked as "unsure" by OCR within the original text.



Args:

    value_obj (Value): The provenance-tracked result from some

                       extraction process.



Returns:

    True if the given Value was extracted without using characters

    that are marked as "unsure" by OCR within the original text,

    and False otherwise (as a Value-wrapped object).



Examples:

    information_is_sure(value) -> Value(False)

information_sureness_above

information_sureness_above(value_obj, percentage)

Returns True if the given Value was extracted using a percentage

of sure characters greater than or equal to the given percentage.



Args:

    value_obj (Value): The provenance-tracked result from some

                       extraction process.

    percentage (Value[float]): A threshold from 0.0 to 1.0 which

                               indicates the threshold for how many

                               characters can be unsure.



Returns:

    True if the given Value was extracted using a percentage

    of sure characters greater than or equal to the given

    percentage, and False otherwise (as a Value-wrapped object).



Examples:

    information_sureness_above(value) -> Value(False)