-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
RecognizeBusinessCardsOptions.cs
56 lines (50 loc) · 2.54 KB
/
RecognizeBusinessCardsOptions.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
using System.Collections.Generic;
namespace Azure.AI.FormRecognizer
{
/// <summary>
/// The set of options that can be specified when calling a Recognize Business Cards method
/// to configure the behavior of the request. For example, specify the content type of the
/// form, the locale of the form, or whether or not to include form elements.
/// </summary>
public class RecognizeBusinessCardsOptions
{
/// <summary>
/// Initializes a new instance of the <see cref="RecognizeBusinessCardsOptions"/> class which
/// allows to set options that can be specified when calling a Recognize Business Cards method
/// to configure the behavior of the request. For example, specify the content type of the
/// form, the locale of the form, or whether or not to include form elements.
/// </summary>
public RecognizeBusinessCardsOptions()
{
}
/// <summary>
/// Whether or not to include all lines per page and field elements such as lines, words,
/// and selection marks for each form field.
/// </summary>
public bool IncludeFieldElements { get; set; }
/// <summary>
/// When set, specifies the content type for uploaded streams and skips automatic
/// content type detection.
/// </summary>
public FormContentType? ContentType { get; set; }
/// <summary>
/// Sets the locale information for the business card.
/// Supported locales include: en-AU, en-CA, en-GB, en-IN, en-US.
/// </summary>
public FormRecognizerLocale? Locale { get; set; }
/// <summary>
/// <para>
/// Custom page numbers for multi-page documents(PDF/TIFF). Input the page numbers
/// and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like
/// `Pages = { "1-3", "5-6" }`. Separate each page number or range with a comma.
/// </para>
/// <para>
/// Although this collection cannot be set, it can be modified.
/// See <see href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/object-and-collection-initializers#object-initializers-with-collection-read-only-property-initialization">Object initializers with collection read-only property initialization</see>.
/// </para>
/// </summary>
public IList<string> Pages { get; } = new List<string>();
}
}