com.ibm.watson.discovery.v1.model

Class SegmentSettings

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.discovery.v1.model.SegmentSettings

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class SegmentSettings
extends com.ibm.cloud.sdk.core.service.model.GenericModel

A list of Document Segmentation settings.

Constructor Summary

Constructors

Constructor and Description
SegmentSettings()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getAnnotatedFields() Gets the annotatedFields.
java.util.List<java.lang.String>	getSelectorTags() Gets the selectorTags.
java.lang.Boolean	isEnabled() Gets the enabled.
void	setAnnotatedFields(java.util.List<java.lang.String> annotatedFields) Sets the annotatedFields.
void	setEnabled(java.lang.Boolean enabled) Sets the enabled.
void	setSelectorTags(java.util.List<java.lang.String> selectorTags) Sets the selectorTags.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentSettings

public SegmentSettings()

Method Detail

isEnabled

public java.lang.Boolean isEnabled()

Gets the enabled. Enables/disables the Document Segmentation feature.

Returns:

the enabled

getSelectorTags

public java.util.List<java.lang.String> getSelectorTags()

Gets the selectorTags. Defines the heading level that splits into document segments. Valid values are h1, h2, h3, h4, h5, h6. The content of the header field that the segmentation splits at is used as the **title** field for that segmented result. Only valid if used with a collection that has **enabled** set to `false` in the **smart_document_understanding** object.

Returns:

the selectorTags

getAnnotatedFields

public java.util.List<java.lang.String> getAnnotatedFields()

Gets the annotatedFields. Defines the annotated smart document understanding fields that the document is split on. The content of the annotated field that the segmentation splits at is used as the **title** field for that segmented result. For example, if the field `sub-title` is specified, when a document is uploaded each time the smart documement understanding conversion encounters a field of type `sub-title` the document is split at that point and the content of the field used as the title of the remaining content. Thnis split is performed for all instances of the listed fields in the uploaded document. Only valid if used with a collection that has **enabled** set to `true` in the **smart_document_understanding** object.

Returns:

the annotatedFields

setEnabled

public void setEnabled(java.lang.Boolean enabled)

Sets the enabled.

Parameters:

enabled - the new enabled

setSelectorTags

public void setSelectorTags(java.util.List<java.lang.String> selectorTags)

Sets the selectorTags.

Parameters:

selectorTags - the new selectorTags

setAnnotatedFields

public void setAnnotatedFields(java.util.List<java.lang.String> annotatedFields)

Sets the annotatedFields.

Parameters:

annotatedFields - the new annotatedFields