ContentUnderstandingSkill Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:12.0.0

public final class ContentUnderstandingSkill
extends SearchIndexerSkill

A skill that leverages Azure AI Content Understanding to process and extract structured insights from documents, enabling enriched, searchable content for enhanced document indexing and retrieval.

Constructor Summary

Constructor Description
ContentUnderstandingSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)

Creates an instance of ContentUnderstandingSkill class.

Method Summary

Modifier and Type Method and Description
static ContentUnderstandingSkill fromJson(JsonReader jsonReader)

Reads an instance of ContentUnderstandingSkill from the JsonReader.
ContentUnderstandingSkillChunkingProperties getChunkingProperties()

Get the chunkingProperties property: Controls the cardinality for chunking the content.
List<ContentUnderstandingSkillExtractionOptions> getExtractionOptions()

Get the extractionOptions property: Controls the cardinality of the content extracted from the document by the skill.
String getOdataType()

Get the odataType property: The discriminator for derived types.
ContentUnderstandingSkill setChunkingProperties(ContentUnderstandingSkillChunkingProperties chunkingProperties)

Set the chunkingProperties property: Controls the cardinality for chunking the content.
ContentUnderstandingSkill setContext(String context)

Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content).
ContentUnderstandingSkill setDescription(String description)

Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
ContentUnderstandingSkill setExtractionOptions(ContentUnderstandingSkillExtractionOptions[] extractionOptions)

Set the extractionOptions property: Controls the cardinality of the content extracted from the document by the skill.
ContentUnderstandingSkill setExtractionOptions(List<ContentUnderstandingSkillExtractionOptions> extractionOptions)

Set the extractionOptions property: Controls the cardinality of the content extracted from the document by the skill.
ContentUnderstandingSkill setName(String name)

Set the name property: The name of the skill which uniquely identifies it within the skillset.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from SearchIndexerSkill

fromJson getContext getDescription getInputs getName getOdataType getOutputs setContext setDescription setName toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ContentUnderstandingSkill

public ContentUnderstandingSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)

Creates an instance of ContentUnderstandingSkill class.

Parameters:

inputs - the inputs value to set.
outputs - the outputs value to set.

Method Details

fromJson

public static ContentUnderstandingSkill fromJson(JsonReader jsonReader)

Reads an instance of ContentUnderstandingSkill from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getChunkingProperties

public ContentUnderstandingSkillChunkingProperties getChunkingProperties()

Get the chunkingProperties property: Controls the cardinality for chunking the content.

Returns:

the chunkingProperties value.

getExtractionOptions

public List<ContentUnderstandingSkillExtractionOptions> getExtractionOptions()

Get the extractionOptions property: Controls the cardinality of the content extracted from the document by the skill.

Returns:

the extractionOptions value.

getOdataType

public String getOdataType()

Get the odataType property: The discriminator for derived types.

Overrides:

ContentUnderstandingSkill.getOdataType()

Returns:

the odataType value.

setChunkingProperties

public ContentUnderstandingSkill setChunkingProperties(ContentUnderstandingSkillChunkingProperties chunkingProperties)

Set the chunkingProperties property: Controls the cardinality for chunking the content.

Parameters:

chunkingProperties - the chunkingProperties value to set.

Returns:

the ContentUnderstandingSkill object itself.

setContext

public ContentUnderstandingSkill setContext(String context)

Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.

Overrides:

ContentUnderstandingSkill.setContext(String context)

Parameters:

context

setDescription

public ContentUnderstandingSkill setDescription(String description)

Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.

Overrides:

ContentUnderstandingSkill.setDescription(String description)

Parameters:

description

setExtractionOptions

public ContentUnderstandingSkill setExtractionOptions(ContentUnderstandingSkillExtractionOptions[] extractionOptions)

Set the extractionOptions property: Controls the cardinality of the content extracted from the document by the skill.

Parameters:

extractionOptions - the extractionOptions value to set.

Returns:

the ContentUnderstandingSkill object itself.

setExtractionOptions

public ContentUnderstandingSkill setExtractionOptions(List<ContentUnderstandingSkillExtractionOptions> extractionOptions)

Set the extractionOptions property: Controls the cardinality of the content extracted from the document by the skill.

Parameters:

extractionOptions - the extractionOptions value to set.

Returns:

the ContentUnderstandingSkill object itself.

setName

public ContentUnderstandingSkill setName(String name)

Set the name property: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.

Overrides:

ContentUnderstandingSkill.setName(String name)

Parameters:

name

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ContentUnderstandingSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to