Package com.affinda.api.client.models

Class Annotation

    • Constructor Detail

      • Annotation

        public Annotation()

    • Method Detail

      • getId

        public int getId()
        Get the id property: Annotation's ID.
        Returns:
        the id value.

      • setId

        public Annotation setId​(int id)
        Set the id property: Annotation's ID.
        Parameters:
        id - the id value to set.
        Returns:
        the Annotation object itself.

      • getRectangle

        public Rectangle getRectangle()
        Get the rectangle property: x/y coordinates for the rectangular bounding box containing the data.
        Returns:
        the rectangle value.

      • setRectangle

        public Annotation setRectangle​(Rectangle rectangle)
        Set the rectangle property: x/y coordinates for the rectangular bounding box containing the data.
        Parameters:
        rectangle - the rectangle value to set.
        Returns:
        the Annotation object itself.

      • getRectangles

        public List<Rectangle> getRectangles()
        Get the rectangles property: x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles.
        Returns:
        the rectangles value.

      • setRectangles

        public Annotation setRectangles​(List<Rectangle> rectangles)
        Set the rectangles property: x/y coordinates for the rectangles containing the data. An annotation can be contained within multiple rectangles.
        Parameters:
        rectangles - the rectangles value to set.
        Returns:
        the Annotation object itself.

      • getDocument

        public String getDocument()
        Get the document property: Uniquely identify a document.
        Returns:
        the document value.

      • setDocument

        public Annotation setDocument​(String document)
        Set the document property: Uniquely identify a document.
        Parameters:
        document - the document value to set.
        Returns:
        the Annotation object itself.

      • getPageIndex

        public Integer getPageIndex()
        Get the pageIndex property: The page number within the document, starting from 0.
        Returns:
        the pageIndex value.

      • setPageIndex

        public Annotation setPageIndex​(Integer pageIndex)
        Set the pageIndex property: The page number within the document, starting from 0.
        Parameters:
        pageIndex - the pageIndex value to set.
        Returns:
        the Annotation object itself.

      • getRaw

        public String getRaw()
        Get the raw property: Raw data extracted from the before any post-processing.
        Returns:
        the raw value.

      • setRaw

        public Annotation setRaw​(String raw)
        Set the raw property: Raw data extracted from the before any post-processing.
        Parameters:
        raw - the raw value to set.
        Returns:
        the Annotation object itself.

      • getConfidence

        public Float getConfidence()
        Get the confidence property: The overall confidence that the model's prediction is correct.
        Returns:
        the confidence value.

      • setConfidence

        public Annotation setConfidence​(Float confidence)
        Set the confidence property: The overall confidence that the model's prediction is correct.
        Parameters:
        confidence - the confidence value to set.
        Returns:
        the Annotation object itself.

      • getClassificationConfidence

        public Float getClassificationConfidence()
        Get the classificationConfidence property: The model's confidence that the text has been classified correctly.
        Returns:
        the classificationConfidence value.

      • setClassificationConfidence

        public Annotation setClassificationConfidence​(Float classificationConfidence)
        Set the classificationConfidence property: The model's confidence that the text has been classified correctly.
        Parameters:
        classificationConfidence - the classificationConfidence value to set.
        Returns:
        the Annotation object itself.

      • getTextExtractionConfidence

        public Float getTextExtractionConfidence()
        Get the textExtractionConfidence property: If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
        Returns:
        the textExtractionConfidence value.

      • setTextExtractionConfidence

        public Annotation setTextExtractionConfidence​(Float textExtractionConfidence)
        Set the textExtractionConfidence property: If the document was submitted as an image, this is the confidence that the text in the image has been correctly read by the model.
        Parameters:
        textExtractionConfidence - the textExtractionConfidence value to set.
        Returns:
        the Annotation object itself.

      • isVerified

        public boolean isVerified()
        Get the isVerified property: Indicates whether the data has been validated, either by a human using our validation tool or through auto-validation rules.
        Returns:
        the isVerified value.

      • setIsVerified

        public Annotation setIsVerified​(boolean isVerified)
        Set the isVerified property: Indicates whether the data has been validated, either by a human using our validation tool or through auto-validation rules.
        Parameters:
        isVerified - the isVerified value to set.
        Returns:
        the Annotation object itself.

      • isClientVerified

        public boolean isClientVerified()
        Get the isClientVerified property: Indicates whether the data has been validated by a human.
        Returns:
        the isClientVerified value.

      • setIsClientVerified

        public Annotation setIsClientVerified​(boolean isClientVerified)
        Set the isClientVerified property: Indicates whether the data has been validated by a human.
        Parameters:
        isClientVerified - the isClientVerified value to set.
        Returns:
        the Annotation object itself.

      • isAutoVerified

        public boolean isAutoVerified()
        Get the isAutoVerified property: Indicates whether the data has been auto-validated.
        Returns:
        the isAutoVerified value.

      • setIsAutoVerified

        public Annotation setIsAutoVerified​(boolean isAutoVerified)
        Set the isAutoVerified property: Indicates whether the data has been auto-validated.
        Parameters:
        isAutoVerified - the isAutoVerified value to set.
        Returns:
        the Annotation object itself.

      • getDataPoint

        public String getDataPoint()
        Get the dataPoint property: Data point's identifier.
        Returns:
        the dataPoint value.

      • setDataPoint

        public Annotation setDataPoint​(String dataPoint)
        Set the dataPoint property: Data point's identifier.
        Parameters:
        dataPoint - the dataPoint value to set.
        Returns:
        the Annotation object itself.

      • getContentType

        public AnnotationContentType getContentType()
        Get the contentType property: The different data types of annotations.
        Returns:
        the contentType value.

      • setContentType

        public Annotation setContentType​(AnnotationContentType contentType)
        Set the contentType property: The different data types of annotations.
        Parameters:
        contentType - the contentType value to set.
        Returns:
        the Annotation object itself.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()
        Get the additionalProperties property: Dictionary of <any>.
        Returns:
        the additionalProperties value.

      • setAdditionalProperties

        public Annotation setAdditionalProperties​(Map<String,​Object> additionalProperties)
        Set the additionalProperties property: Dictionary of <any>.
        Parameters:
        additionalProperties - the additionalProperties value to set.
        Returns:
        the Annotation object itself.