KeyPhrase (AWS SDK for Android

java.lang.Object
- com.amazonaws.services.comprehend.model.KeyPhrase

All Implemented Interfaces:

java.io.Serializable
```
public class KeyPhrase
extends java.lang.Object
implements java.io.Serializable
```
Describes a key noun phrase.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

KeyPhrase()

Constructors
Constructor and Description
`KeyPhrase()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Integer`	`getBeginOffset()` A character offset in the input text that shows where the key phrase begins (the first character is at position 0).
`java.lang.Integer`	`getEndOffset()` A character offset in the input text where the key phrase ends.
`java.lang.Float`	`getScore()` The level of confidence that Amazon Comprehend has in the accuracy of the detection.
`java.lang.String`	`getText()` The text of a key noun phrase.
`int`	`hashCode()`
`void`	`setBeginOffset(java.lang.Integer beginOffset)` A character offset in the input text that shows where the key phrase begins (the first character is at position 0).
`void`	`setEndOffset(java.lang.Integer endOffset)` A character offset in the input text where the key phrase ends.
`void`	`setScore(java.lang.Float score)` The level of confidence that Amazon Comprehend has in the accuracy of the detection.
`void`	`setText(java.lang.String text)` The text of a key noun phrase.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`KeyPhrase`	`withBeginOffset(java.lang.Integer beginOffset)` A character offset in the input text that shows where the key phrase begins (the first character is at position 0).
`KeyPhrase`	`withEndOffset(java.lang.Integer endOffset)` A character offset in the input text where the key phrase ends.
`KeyPhrase`	`withScore(java.lang.Float score)` The level of confidence that Amazon Comprehend has in the accuracy of the detection.
`KeyPhrase`	`withText(java.lang.String text)` The text of a key noun phrase.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KeyPhrase
```
public KeyPhrase()
```
- Method Detail
  - getScore
```
public java.lang.Float getScore()
```
    The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    
    Returns:
    
    The level of confidence that Amazon Comprehend has in the accuracy of the detection.
  - setScore
```
public void setScore(java.lang.Float score)
```
    The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    
    Parameters:
    
    score -
    The level of confidence that Amazon Comprehend has in the accuracy of the detection.
  - withScore
```
public KeyPhrase withScore(java.lang.Float score)
```
    The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    score -
    The level of confidence that Amazon Comprehend has in the accuracy of the detection.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getText
```
public java.lang.String getText()
```
    The text of a key noun phrase.
    
    Constraints:
    Length: 1 -
    
    Returns:
    
    The text of a key noun phrase.
  - setText
```
public void setText(java.lang.String text)
```
    The text of a key noun phrase.
    
    Constraints:
    Length: 1 -
    
    Parameters:
    
    text -
    The text of a key noun phrase.
  - withText
```
public KeyPhrase withText(java.lang.String text)
```
    The text of a key noun phrase.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 -
    
    Parameters:
    
    text -
    The text of a key noun phrase.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getBeginOffset
```
public java.lang.Integer getBeginOffset()
```
    A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
    
    Returns:
    
    A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
  - setBeginOffset
```
public void setBeginOffset(java.lang.Integer beginOffset)
```
    A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
    
    Parameters:
    
    beginOffset -
    A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
  - withBeginOffset
```
public KeyPhrase withBeginOffset(java.lang.Integer beginOffset)
```
    A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    beginOffset -
    A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEndOffset
```
public java.lang.Integer getEndOffset()
```
    A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
    
    Returns:
    
    A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
  - setEndOffset
```
public void setEndOffset(java.lang.Integer endOffset)
```
    A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
    
    Parameters:
    
    endOffset -
    A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
  - withEndOffset
```
public KeyPhrase withEndOffset(java.lang.Integer endOffset)
```
    A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    endOffset -
    A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class KeyPhrase

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeyPhrase

Method Detail

getScore

setScore

withScore

getText

setText

withText

getBeginOffset

setBeginOffset

withBeginOffset

getEndOffset

setEndOffset

withEndOffset

toString

hashCode

equals