Package com.azure.search.documents.indexes.models

Class SearchIndexerSkill

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkill>
Direct Known Subclasses:
AzureMachineLearningSkill, AzureOpenAIEmbeddingSkill, ConditionalSkill, CustomEntityLookupSkill, DocumentExtractionSkill, DocumentIntelligenceLayoutSkill, EntityLinkingSkill, EntityRecognitionSkill, ImageAnalysisSkill, KeyPhraseExtractionSkill, LanguageDetectionSkill, MergeSkill, OcrSkill, PiiDetectionSkill, SentimentSkill, ShaperSkill, SplitSkill, TextTranslationSkill, VisionVectorizeSkill, WebApiSkill
public class SearchIndexerSkill extends Object implements com.azure.json.JsonSerializable<SearchIndexerSkill>
Base type for skills.

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static SearchIndexerSkill
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of SearchIndexerSkill from the JsonReader.
    String
    getContext()
    Get 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).
    String
    getDescription()
    Get the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
    List<InputFieldMappingEntry>
    getInputs()
    Get the inputs property: Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
    String
    getName()
    Get the name property: The name of the skill which uniquely identifies it within the skillset.
    String
    getOdataType()
    Get the odataType property: A URI fragment specifying the type of skill.
    List<OutputFieldMappingEntry>
    getOutputs()
    Get the outputs property: The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.
    SearchIndexerSkill
    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).
    SearchIndexerSkill
    setDescription(String description)
    Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
    SearchIndexerSkill
    setName(String name)
    Set the name property: The name of the skill which uniquely identifies it within the skillset.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

  • Method Details

    • getOdataType

      public String getOdataType()
      Get the odataType property: A URI fragment specifying the type of skill.
      Returns:
      the odataType value.

    • getName

      public String getName()
      Get 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 '#'.
      Returns:
      the name value.

    • setName

      public SearchIndexerSkill 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 '#'.
      Parameters:
      name - the name value to set.
      Returns:
      the SearchIndexerSkill object itself.

    • getDescription

      public String getDescription()
      Get the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
      Returns:
      the description value.

    • setDescription

      public SearchIndexerSkill setDescription(String description)
      Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
      Parameters:
      description - the description value to set.
      Returns:
      the SearchIndexerSkill object itself.

    • getContext

      public String getContext()
      Get 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.
      Returns:
      the context value.

    • setContext

      public SearchIndexerSkill 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.
      Parameters:
      context - the context value to set.
      Returns:
      the SearchIndexerSkill object itself.

    • getInputs

      public List<InputFieldMappingEntry> getInputs()
      Get the inputs property: Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
      Returns:
      the inputs value.

    • getOutputs

      public List<OutputFieldMappingEntry> getOutputs()
      Get the outputs property: The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.
      Returns:
      the outputs value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<SearchIndexerSkill>
      Throws:
      IOException

    • fromJson

      public static SearchIndexerSkill fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of SearchIndexerSkill from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of SearchIndexerSkill if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the SearchIndexerSkill.