Class OcrSkill

java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
com.azure.search.documents.indexes.models.OcrSkill
All Implemented Interfaces:
com.azure.json.JsonSerializable<SearchIndexerSkill>
public final class OcrSkill extends SearchIndexerSkill
A skill that extracts text from image files.

  • Constructor Details

  • Method Details

    • getOdataType

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

    • getDefaultLanguageCode

      public OcrSkillLanguage getDefaultLanguageCode()
      Get the defaultLanguageCode property: A value indicating which language code to use. Default is `en`.
      Returns:
      the defaultLanguageCode value.

    • setDefaultLanguageCode

      public OcrSkill setDefaultLanguageCode(OcrSkillLanguage 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 OcrSkill object itself.

    • isShouldDetectOrientation

      public Boolean isShouldDetectOrientation()
      Get the shouldDetectOrientation property: A value indicating to turn orientation detection on or not. Default is false.
      Returns:
      the shouldDetectOrientation value.

    • setShouldDetectOrientation

      public OcrSkill setShouldDetectOrientation(Boolean shouldDetectOrientation)
      Set the shouldDetectOrientation property: A value indicating to turn orientation detection on or not. Default is false.
      Parameters:
      shouldDetectOrientation - the shouldDetectOrientation value to set.
      Returns:
      the OcrSkill object itself.

    • getLineEnding

      public OcrLineEnding getLineEnding()
      Get the lineEnding property: Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space".
      Returns:
      the lineEnding value.

    • setLineEnding

      public OcrSkill setLineEnding(OcrLineEnding lineEnding)
      Set the lineEnding property: Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is "space".
      Parameters:
      lineEnding - the lineEnding value to set.
      Returns:
      the OcrSkill object itself.

    • setName

      public OcrSkill 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:
      setName in class SearchIndexerSkill
      Parameters:
      name - the name value to set.
      Returns:
      the SearchIndexerSkill object itself.

    • setDescription

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

    • setContext

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

    • toJson

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

    • fromJson

      public static OcrSkill fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of OcrSkill from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of OcrSkill 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 OcrSkill.

    • setShouldDetectOrientation

      @Deprecated public Boolean setShouldDetectOrientation()
      Deprecated.
      Use isShouldDetectOrientation() instead.
      Get the shouldDetectOrientation property: A value indicating to turn orientation detection on or not. Default is false.
      Returns:
      the shouldDetectOrientation value.