com.amazonaws.services.comprehend.model

Class ClassifyDocumentResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.comprehend.model.ClassifyDocumentResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ClassifyDocumentResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClassifyDocumentResult()

Method Summary

Modifier and Type	Method and Description
ClassifyDocumentResult	clone()
boolean	equals(Object obj)
List<DocumentClass>	getClasses() The classes used by the document being analyzed.
List<DocumentLabel>	getLabels() The labels used the document being analyzed.
int	hashCode()
void	setClasses(Collection<DocumentClass> classes) The classes used by the document being analyzed.
void	setLabels(Collection<DocumentLabel> labels) The labels used the document being analyzed.
String	toString() Returns a string representation of this object.
ClassifyDocumentResult	withClasses(Collection<DocumentClass> classes) The classes used by the document being analyzed.
ClassifyDocumentResult	withClasses(DocumentClass... classes) The classes used by the document being analyzed.
ClassifyDocumentResult	withLabels(Collection<DocumentLabel> labels) The labels used the document being analyzed.
ClassifyDocumentResult	withLabels(DocumentLabel... labels) The labels used the document being analyzed.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ClassifyDocumentResult

public ClassifyDocumentResult()

Method Detail

getClasses

public List<DocumentClass> getClasses()

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

Returns:

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

setClasses

public void setClasses(Collection<DocumentClass> classes)

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

Parameters:

classes - The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

withClasses

public ClassifyDocumentResult withClasses(DocumentClass... classes)

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

NOTE: This method appends the values to the existing list (if any). Use setClasses(java.util.Collection) or withClasses(java.util.Collection) if you want to override the existing values.

Parameters:

classes - The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

Returns:

Returns a reference to this object so that method calls can be chained together.

withClasses

public ClassifyDocumentResult withClasses(Collection<DocumentClass> classes)

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

Parameters:

classes - The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

Returns:

Returns a reference to this object so that method calls can be chained together.

getLabels

public List<DocumentLabel> getLabels()

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

Returns:

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

setLabels

public void setLabels(Collection<DocumentLabel> labels)

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

Parameters:

labels - The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

withLabels

public ClassifyDocumentResult withLabels(DocumentLabel... labels)

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

NOTE: This method appends the values to the existing list (if any). Use setLabels(java.util.Collection) or withLabels(java.util.Collection) if you want to override the existing values.

Parameters:

labels - The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

Returns:

Returns a reference to this object so that method calls can be chained together.

withLabels

public ClassifyDocumentResult withLabels(Collection<DocumentLabel> labels)

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

Parameters:

labels - The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ClassifyDocumentResult clone()

Overrides:

clone in class Object