Annotation (Java Client Library for Affinda Resume Parser API 0.6.0 API)

java.lang.Object
- com.affinda.api.client.models.Annotation

Direct Known Subclasses:

DateAnnotation, EnumAnnotationSerializer, ExpectedRemunerationAnnotation, JobTitleAnnotation, LanguageAnnotation, LocationAnnotation, SkillAnnotation, TextAnnotation, YearsExperienceAnnotation
```
public class Annotation
extends Object
```
The Annotation model.

Constructor Summary

Constructors
Constructor and Description

Annotation()

Constructors
Constructor and Description
`Annotation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Map<String,Object>`	`getAdditionalProperties()` Get the additionalProperties property: Dictionary of <any>.
`String`	`getClassification()` Get the classification property: The classification property.
`Float`	`getClassificationConfidence()` Get the classificationConfidence property: The AI model confidence.
`Float`	`getConfidence()` Get the confidence property: Combined confidence from the model confidence and the OCR confidence.
`Integer`	`getId()` Get the id property: The id property.
`Integer`	`getPageIndex()` Get the pageIndex property: The pageIndex property.
`String`	`getRaw()` Get the raw property: The raw property.
`Rectangle`	`getRectangle()` Get the rectangle property: The rectangle property.
`Float`	`getTextExtractionConfidence()` Get the textExtractionConfidence property: The OCR confidence.
`Boolean`	`isAutoVerified()` Get the isAutoVerified property: The isAutoVerified property.
`Boolean`	`isClientVerified()` Get the isClientVerified property: The isClientVerified property.
`boolean`	`isVerified()` Get the isVerified property: The isVerified property.
`Annotation`	`setAdditionalProperties(Map<String,Object> additionalProperties)` Set the additionalProperties property: Dictionary of <any>.
`Annotation`	`setClassification(String classification)` Set the classification property: The classification property.
`Annotation`	`setClassificationConfidence(Float classificationConfidence)` Set the classificationConfidence property: The AI model confidence.
`Annotation`	`setConfidence(Float confidence)` Set the confidence property: Combined confidence from the model confidence and the OCR confidence.
`Annotation`	`setId(Integer id)` Set the id property: The id property.
`Annotation`	`setIsAutoVerified(Boolean isAutoVerified)` Set the isAutoVerified property: The isAutoVerified property.
`Annotation`	`setIsClientVerified(Boolean isClientVerified)` Set the isClientVerified property: The isClientVerified property.
`Annotation`	`setIsVerified(boolean isVerified)` Set the isVerified property: The isVerified property.
`Annotation`	`setPageIndex(Integer pageIndex)` Set the pageIndex property: The pageIndex property.
`Annotation`	`setRaw(String raw)` Set the raw property: The raw property.
`Annotation`	`setRectangle(Rectangle rectangle)` Set the rectangle property: The rectangle property.
`Annotation`	`setTextExtractionConfidence(Float textExtractionConfidence)` Set the textExtractionConfidence property: The OCR confidence.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Annotation
```
public Annotation()
```
- Method Detail
  - getId
```
public Integer getId()
```
    Get the id property: The id property.
    
    Returns:
    
    the id value.
  - setId
```
public Annotation setId(Integer id)
```
    Set the id property: The id property.
    
    Parameters:
    
    id - the id value to set.
    
    Returns:
    
    the Annotation object itself.
  - getRectangle
```
public Rectangle getRectangle()
```
    Get the rectangle property: The rectangle property.
    
    Returns:
    
    the rectangle value.
  - setRectangle
```
public Annotation setRectangle(Rectangle rectangle)
```
    Set the rectangle property: The rectangle property.
    
    Parameters:
    
    rectangle - the rectangle value to set.
    
    Returns:
    
    the Annotation object itself.
  - getPageIndex
```
public Integer getPageIndex()
```
    Get the pageIndex property: The pageIndex property.
    
    Returns:
    
    the pageIndex value.
  - setPageIndex
```
public Annotation setPageIndex(Integer pageIndex)
```
    Set the pageIndex property: The pageIndex property.
    
    Parameters:
    
    pageIndex - the pageIndex value to set.
    
    Returns:
    
    the Annotation object itself.
  - getRaw
```
public String getRaw()
```
    Get the raw property: The raw property.
    
    Returns:
    
    the raw value.
  - setRaw
```
public Annotation setRaw(String raw)
```
    Set the raw property: The raw property.
    
    Parameters:
    
    raw - the raw value to set.
    
    Returns:
    
    the Annotation object itself.
  - getConfidence
```
public Float getConfidence()
```
    Get the confidence property: Combined confidence from the model confidence and the OCR confidence.
    
    Returns:
    
    the confidence value.
  - setConfidence
```
public Annotation setConfidence(Float confidence)
```
    Set the confidence property: Combined confidence from the model confidence and the OCR confidence.
    
    Parameters:
    
    confidence - the confidence value to set.
    
    Returns:
    
    the Annotation object itself.
  - getClassificationConfidence
```
public Float getClassificationConfidence()
```
    Get the classificationConfidence property: The AI model confidence.
    
    Returns:
    
    the classificationConfidence value.
  - setClassificationConfidence
```
public Annotation setClassificationConfidence(Float classificationConfidence)
```
    Set the classificationConfidence property: The AI model confidence.
    
    Parameters:
    
    classificationConfidence - the classificationConfidence value to set.
    
    Returns:
    
    the Annotation object itself.
  - getTextExtractionConfidence
```
public Float getTextExtractionConfidence()
```
    Get the textExtractionConfidence property: The OCR confidence.
    
    Returns:
    
    the textExtractionConfidence value.
  - setTextExtractionConfidence
```
public Annotation setTextExtractionConfidence(Float textExtractionConfidence)
```
    Set the textExtractionConfidence property: The OCR confidence.
    
    Parameters:
    
    textExtractionConfidence - the textExtractionConfidence value to set.
    
    Returns:
    
    the Annotation object itself.
  - isVerified
```
public boolean isVerified()
```
    Get the isVerified property: The isVerified property.
    
    Returns:
    
    the isVerified value.
  - setIsVerified
```
public Annotation setIsVerified(boolean isVerified)
```
    Set the isVerified property: The isVerified property.
    
    Parameters:
    
    isVerified - the isVerified value to set.
    
    Returns:
    
    the Annotation object itself.
  - isClientVerified
```
public Boolean isClientVerified()
```
    Get the isClientVerified property: The isClientVerified property.
    
    Returns:
    
    the isClientVerified value.
  - setIsClientVerified
```
public Annotation setIsClientVerified(Boolean isClientVerified)
```
    Set the isClientVerified property: The isClientVerified property.
    
    Parameters:
    
    isClientVerified - the isClientVerified value to set.
    
    Returns:
    
    the Annotation object itself.
  - isAutoVerified
```
public Boolean isAutoVerified()
```
    Get the isAutoVerified property: The isAutoVerified property.
    
    Returns:
    
    the isAutoVerified value.
  - setIsAutoVerified
```
public Annotation setIsAutoVerified(Boolean isAutoVerified)
```
    Set the isAutoVerified property: The isAutoVerified property.
    
    Parameters:
    
    isAutoVerified - the isAutoVerified value to set.
    
    Returns:
    
    the Annotation object itself.
  - getClassification
```
public String getClassification()
```
    Get the classification property: The classification property.
    
    Returns:
    
    the classification value.
  - setClassification
```
public Annotation setClassification(String classification)
```
    Set the classification property: The classification property.
    
    Parameters:
    
    classification - the classification 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.

Class Annotation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Annotation

Method Detail

getId

setId

getRectangle

setRectangle

getPageIndex

setPageIndex

getRaw

setRaw

getConfidence

setConfidence

getClassificationConfidence

setClassificationConfidence

getTextExtractionConfidence

setTextExtractionConfidence

isVerified

setIsVerified

isClientVerified

setIsClientVerified

isAutoVerified

setIsAutoVerified

getClassification

setClassification

getAdditionalProperties

setAdditionalProperties