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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SegmentSettings.Builder Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	annotatedFields
protected java.lang.Boolean	enabled
protected java.util.List<java.lang.String>	selectorTags

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SegmentSettings(SegmentSettings.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	annotatedFields() Gets the annotatedFields.
java.lang.Boolean	enabled() Gets the enabled.
SegmentSettings.Builder	newBuilder() New builder.
java.util.List<java.lang.String>	selectorTags() Gets 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

Field Detail

enabled

protected java.lang.Boolean enabled

selectorTags

@SerializedName(value="selector_tags")
protected java.util.List<java.lang.String> selectorTags

annotatedFields

@SerializedName(value="annotated_fields")
protected java.util.List<java.lang.String> annotatedFields

Constructor Detail

SegmentSettings

protected SegmentSettings(SegmentSettings.Builder builder)

Method Detail

newBuilder

public SegmentSettings.Builder newBuilder()

New builder.

Returns:

a SegmentSettings builder

enabled

public java.lang.Boolean enabled()

Gets the enabled.

Enables/disables the Document Segmentation feature.

Returns:

the enabled

selectorTags

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

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

annotatedFields

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

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