ContentUnderstandingSkillChunkingProperties Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:12.0.0

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

Implements

JsonSerializable<ContentUnderstandingSkillChunkingProperties>

public final class ContentUnderstandingSkillChunkingProperties
implements JsonSerializable<ContentUnderstandingSkillChunkingProperties>

Controls the cardinality for chunking the content.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static ContentUnderstandingSkillChunkingProperties	fromJson(JsonReader jsonReader) Reads an instance of ContentUnderstandingSkillChunkingProperties 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.
ContentUnderstandingSkillChunkingUnit	getUnit() Get the unit property: The unit of the chunk.
ContentUnderstandingSkillChunkingProperties	setMaximumLength(Integer maximumLength) Set the maximumLength property: The maximum chunk length in characters.
ContentUnderstandingSkillChunkingProperties	setOverlapLength(Integer overlapLength) Set the overlapLength property: The length of overlap provided between two text chunks.
ContentUnderstandingSkillChunkingProperties	setUnit(ContentUnderstandingSkillChunkingUnit 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

ContentUnderstandingSkillChunkingProperties

public ContentUnderstandingSkillChunkingProperties()

Creates an instance of ContentUnderstandingSkillChunkingProperties class.

Method Details

fromJson

public static ContentUnderstandingSkillChunkingProperties fromJson(JsonReader jsonReader)

Reads an instance of ContentUnderstandingSkillChunkingProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ContentUnderstandingSkillChunkingProperties 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 ContentUnderstandingSkillChunkingProperties.

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 ContentUnderstandingSkillChunkingUnit getUnit()

Get the unit property: The unit of the chunk.

Returns:

the unit value.

setMaximumLength

public ContentUnderstandingSkillChunkingProperties 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 ContentUnderstandingSkillChunkingProperties object itself.

setOverlapLength

public ContentUnderstandingSkillChunkingProperties 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 ContentUnderstandingSkillChunkingProperties object itself.

setUnit

public ContentUnderstandingSkillChunkingProperties setUnit(ContentUnderstandingSkillChunkingUnit unit)

Set the unit property: The unit of the chunk.

Parameters:

unit - the unit value to set.

Returns:

the ContentUnderstandingSkillChunkingProperties object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException