ImageAnalysisSkill 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.SearchIndexerSkill
  • • com.azure.search.documents.indexes.models.ImageAnalysisSkill

public final class ImageAnalysisSkill
extends SearchIndexerSkill

A skill that analyzes image files. It extracts a rich set of visual features based on the image content.

Constructor Summary

Constructor	Description
ImageAnalysisSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)	Creates an instance of ImageAnalysisSkill class.

Method Summary

Modifier and Type	Method and Description
static ImageAnalysisSkill	fromJson(JsonReader jsonReader) Reads an instance of ImageAnalysisSkill from the JsonReader.
ImageAnalysisSkillLanguage	getDefaultLanguageCode() Get the defaultLanguageCode property: A value indicating which language code to use.
List<ImageDetail>	getDetails() Get the details property: A string indicating which domain-specific details to return.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of skill.
List<VisualFeature>	getVisualFeatures() Get the visualFeatures property: A list of visual features.
ImageAnalysisSkill	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).
ImageAnalysisSkill	setDefaultLanguageCode(ImageAnalysisSkillLanguage defaultLanguageCode) Set the defaultLanguageCode property: A value indicating which language code to use.
ImageAnalysisSkill	setDescription(String description) Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
ImageAnalysisSkill	setDetails(ImageDetail[] details) Set the details property: A string indicating which domain-specific details to return.
ImageAnalysisSkill	setDetails(List<ImageDetail> details) Set the details property: A string indicating which domain-specific details to return.
ImageAnalysisSkill	setName(String name) Set the name property: The name of the skill which uniquely identifies it within the skillset.
ImageAnalysisSkill	setVisualFeatures(List<VisualFeature> visualFeatures) Set the visualFeatures property: A list of visual features.
ImageAnalysisSkill	setVisualFeatures(VisualFeature[] visualFeatures) Set the visualFeatures property: A list of visual features.
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

ImageAnalysisSkill

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

Creates an instance of ImageAnalysisSkill class.

Parameters:

inputs - the inputs value to set.

outputs - the outputs value to set.

Method Details

fromJson

public static ImageAnalysisSkill fromJson(JsonReader jsonReader)

Reads an instance of ImageAnalysisSkill from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getDefaultLanguageCode

public ImageAnalysisSkillLanguage getDefaultLanguageCode()

Get the defaultLanguageCode property: A value indicating which language code to use. Default is `en`.

Returns:

the defaultLanguageCode value.

getDetails

public List<ImageDetail> getDetails()

Get the details property: A string indicating which domain-specific details to return.

Returns:

the details value.

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of skill.

Overrides:

ImageAnalysisSkill.getOdataType()

Returns:

the odataType value.

getVisualFeatures

public List<VisualFeature> getVisualFeatures()

Get the visualFeatures property: A list of visual features.

Returns:

the visualFeatures value.

setContext

public ImageAnalysisSkill 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:

ImageAnalysisSkill.setContext(String context)

Parameters:

context

setDefaultLanguageCode

public ImageAnalysisSkill setDefaultLanguageCode(ImageAnalysisSkillLanguage defaultLanguageCode)

Set the defaultLanguageCode property: A value indicating which language code to use. Default is `en`.

Parameters:

defaultLanguageCode - the defaultLanguageCode value to set.

Returns:

the ImageAnalysisSkill object itself.

setDescription

public ImageAnalysisSkill setDescription(String description)

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

Overrides:

ImageAnalysisSkill.setDescription(String description)

Parameters:

description

setDetails

public ImageAnalysisSkill setDetails(ImageDetail[] details)

Set the details property: A string indicating which domain-specific details to return.

Parameters:

details - the details value to set.

Returns:

the ImageAnalysisSkill object itself.

setDetails

public ImageAnalysisSkill setDetails(List<ImageDetail> details)

Set the details property: A string indicating which domain-specific details to return.

Parameters:

details - the details value to set.

Returns:

the ImageAnalysisSkill object itself.

setName

public ImageAnalysisSkill 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:

ImageAnalysisSkill.setName(String name)

Parameters:

name

setVisualFeatures

public ImageAnalysisSkill setVisualFeatures(List<VisualFeature> visualFeatures)

Set the visualFeatures property: A list of visual features.

Parameters:

visualFeatures - the visualFeatures value to set.

Returns:

the ImageAnalysisSkill object itself.

setVisualFeatures

public ImageAnalysisSkill setVisualFeatures(VisualFeature[] visualFeatures)

Set the visualFeatures property: A list of visual features.

Parameters:

visualFeatures - the visualFeatures value to set.

Returns:

the ImageAnalysisSkill object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ImageAnalysisSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException