< Summary

Class:Microsoft.Azure.Search.Models.OcrSkill
Assembly:Microsoft.Azure.Search.Service
File(s):C:\Git\azure-sdk-for-net\sdk\search\Microsoft.Azure.Search.Service\src\Generated\Models\OcrSkill.cs
Covered lines:12
Uncovered lines:0
Coverable lines:12
Total lines:112
Line coverage:100% (12 of 12)
Covered branches:0
Total branches:0

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
.ctor()-100%100%
.ctor(...)-100%100%
get_TextExtractionAlgorithm()-100%100%
get_DefaultLanguageCode()-100%100%
get_ShouldDetectOrientation()-100%100%
Validate()-100%100%

File(s)

C:\Git\azure-sdk-for-net\sdk\search\Microsoft.Azure.Search.Service\src\Generated\Models\OcrSkill.cs

#LineLine coverage
 1// <auto-generated>
 2// Copyright (c) Microsoft Corporation. All rights reserved.
 3// Licensed under the MIT License. See License.txt in the project root for
 4// license information.
 5//
 6// Code generated by Microsoft (R) AutoRest Code Generator.
 7// Changes may cause incorrect behavior and will be lost if the code is
 8// regenerated.
 9// </auto-generated>
 10
 11namespace Microsoft.Azure.Search.Models
 12{
 13    using Newtonsoft.Json;
 14    using System.Collections;
 15    using System.Collections.Generic;
 16    using System.Linq;
 17
 18    /// <summary>
 19    /// A skill that extracts text from image files.
 20    /// <see
 21    /// href="https://docs.microsoft.com/azure/search/cognitive-search-skill-ocr"
 22    /// />
 23    /// </summary>
 24    [Newtonsoft.Json.JsonObject("#Microsoft.Skills.Vision.OcrSkill")]
 25    public partial class OcrSkill : Skill
 26    {
 27        /// <summary>
 28        /// Initializes a new instance of the OcrSkill class.
 29        /// </summary>
 5430        public OcrSkill()
 31        {
 32            CustomInit();
 5433        }
 34
 35        /// <summary>
 36        /// Initializes a new instance of the OcrSkill class.
 37        /// </summary>
 38        /// <param name="inputs">Inputs of the skills could be a column in the
 39        /// source data set, or the output of an upstream skill.</param>
 40        /// <param name="outputs">The output of a skill is either a field in a
 41        /// search index, or a value that can be consumed as an input by
 42        /// another skill.</param>
 43        /// <param name="name">The name of the skill which uniquely identifies
 44        /// it within the skillset. A skill with no name defined will be given
 45        /// a default name of its 1-based index in the skills array, prefixed
 46        /// with the character '#'.</param>
 47        /// <param name="description">The description of the skill which
 48        /// describes the inputs, outputs, and usage of the skill.</param>
 49        /// <param name="context">Represents the level at which operations take
 50        /// place, such as the document root or document content (for example,
 51        /// /document or /document/content). The default is /document.</param>
 52        /// <param name="textExtractionAlgorithm">A value indicating which
 53        /// algorithm to use for extracting text. Default is printed. Possible
 54        /// values include: 'printed', 'handwritten'</param>
 55        /// <param name="defaultLanguageCode">A value indicating which language
 56        /// code to use. Default is en. Possible values include: 'zh-Hans',
 57        /// 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu',
 58        /// 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar',
 59        /// 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'</param>
 60        /// <param name="shouldDetectOrientation">A value indicating to turn
 61        /// orientation detection on or not. Default is false.</param>
 62        public OcrSkill(IList<InputFieldMappingEntry> inputs, IList<OutputFieldMappingEntry> outputs, string name = defa
 4863            : base(inputs, outputs, name, description, context)
 64        {
 4865            TextExtractionAlgorithm = textExtractionAlgorithm;
 4866            DefaultLanguageCode = defaultLanguageCode;
 4867            ShouldDetectOrientation = shouldDetectOrientation;
 68            CustomInit();
 4869        }
 70
 71        /// <summary>
 72        /// An initialization method that performs custom operations like setting defaults
 73        /// </summary>
 74        partial void CustomInit();
 75
 76        /// <summary>
 77        /// Gets or sets a value indicating which algorithm to use for
 78        /// extracting text. Default is printed. Possible values include:
 79        /// 'printed', 'handwritten'
 80        /// </summary>
 81        [JsonProperty(PropertyName = "textExtractionAlgorithm")]
 26482        public TextExtractionAlgorithm? TextExtractionAlgorithm { get; set; }
 83
 84        /// <summary>
 85        /// Gets or sets a value indicating which language code to use. Default
 86        /// is en. Possible values include: 'zh-Hans', 'zh-Hant', 'cs', 'da',
 87        /// 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb',
 88        /// 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl',
 89        /// 'sr-Latn', 'sk'
 90        /// </summary>
 91        [JsonProperty(PropertyName = "defaultLanguageCode")]
 26492        public OcrSkillLanguage? DefaultLanguageCode { get; set; }
 93
 94        /// <summary>
 95        /// Gets or sets a value indicating to turn orientation detection on or
 96        /// not. Default is false.
 97        /// </summary>
 98        [JsonProperty(PropertyName = "detectOrientation")]
 23499        public bool? ShouldDetectOrientation { get; set; }
 100
 101        /// <summary>
 102        /// Validate the object.
 103        /// </summary>
 104        /// <exception cref="Rest.ValidationException">
 105        /// Thrown if validation fails
 106        /// </exception>
 107        public override void Validate()
 108        {
 48109            base.Validate();
 48110        }
 111    }
 112}