DocumentIntelligenceLayoutSkillChunkingProperties Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.8.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.DocumentIntelligenceLayoutSkillChunkingProperties

Implements

JsonSerializable<DocumentIntelligenceLayoutSkillChunkingProperties>

public final class DocumentIntelligenceLayoutSkillChunkingProperties
implements JsonSerializable<DocumentIntelligenceLayoutSkillChunkingProperties>

Controls the cardinality for chunking the content.

Constructor Summary

Constructor	Description
DocumentIntelligenceLayoutSkillChunkingProperties()	Creates an instance of DocumentIntelligenceLayoutSkillChunkingProperties class.

Method Summary

Modifier and Type	Method and Description
static DocumentIntelligenceLayoutSkillChunkingProperties	fromJson(JsonReader jsonReader) Reads an instance of DocumentIntelligenceLayoutSkillChunkingProperties from the JsonReader.
Integer	getMaximumLength() Get the maximumLength property: The maximum chunk length in characters.
Integer	getOverlapLength() Get the overlapLength property: The length of overlap provided between two text chunks.
DocumentIntelligenceLayoutSkillChunkingUnit	getUnit() Get the unit property: The unit of the chunk.
DocumentIntelligenceLayoutSkillChunkingProperties	setMaximumLength(Integer maximumLength) Set the maximumLength property: The maximum chunk length in characters.
DocumentIntelligenceLayoutSkillChunkingProperties	setOverlapLength(Integer overlapLength) Set the overlapLength property: The length of overlap provided between two text chunks.
DocumentIntelligenceLayoutSkillChunkingProperties	setUnit(DocumentIntelligenceLayoutSkillChunkingUnit unit) Set the unit property: The unit of the chunk.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DocumentIntelligenceLayoutSkillChunkingProperties

public DocumentIntelligenceLayoutSkillChunkingProperties()

Creates an instance of DocumentIntelligenceLayoutSkillChunkingProperties class.

Method Details

fromJson

public static DocumentIntelligenceLayoutSkillChunkingProperties fromJson(JsonReader jsonReader)

Reads an instance of DocumentIntelligenceLayoutSkillChunkingProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of DocumentIntelligenceLayoutSkillChunkingProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the DocumentIntelligenceLayoutSkillChunkingProperties.

getMaximumLength

public Integer getMaximumLength()

Get the maximumLength property: The maximum chunk length in characters. Default is 500.

Returns:

the maximumLength value.

getOverlapLength

public Integer getOverlapLength()

Get the overlapLength property: The length of overlap provided between two text chunks. Default is 0.

Returns:

the overlapLength value.

getUnit

public DocumentIntelligenceLayoutSkillChunkingUnit getUnit()

Get the unit property: The unit of the chunk.

Returns:

the unit value.

setMaximumLength

public DocumentIntelligenceLayoutSkillChunkingProperties setMaximumLength(Integer maximumLength)

Set the maximumLength property: The maximum chunk length in characters. Default is 500.

Parameters:

maximumLength - the maximumLength value to set.

Returns:

the DocumentIntelligenceLayoutSkillChunkingProperties object itself.

setOverlapLength

public DocumentIntelligenceLayoutSkillChunkingProperties setOverlapLength(Integer overlapLength)

Set the overlapLength property: The length of overlap provided between two text chunks. Default is 0.

Parameters:

overlapLength - the overlapLength value to set.

Returns:

the DocumentIntelligenceLayoutSkillChunkingProperties object itself.

setUnit

public DocumentIntelligenceLayoutSkillChunkingProperties setUnit(DocumentIntelligenceLayoutSkillChunkingUnit unit)

Set the unit property: The unit of the chunk.

Parameters:

unit - the unit value to set.

Returns:

the DocumentIntelligenceLayoutSkillChunkingProperties object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException