-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
DocumentParagraph.cs
101 lines (92 loc) · 4.4 KB
/
DocumentParagraph.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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// <auto-generated/>
#nullable disable
using System;
using System.Collections.Generic;
using System.Linq;
namespace Azure.AI.DocumentIntelligence
{
/// <summary>
/// A paragraph object consisting with contiguous lines generally with common
/// alignment and spacing.
/// </summary>
public partial class DocumentParagraph
{
/// <summary>
/// Keeps track of any properties unknown to the library.
/// <para>
/// To assign an object to the value of this property use <see cref="BinaryData.FromObjectAsJson{T}(T, System.Text.Json.JsonSerializerOptions?)"/>.
/// </para>
/// <para>
/// To assign an already formatted json string to this property use <see cref="BinaryData.FromString(string)"/>.
/// </para>
/// <para>
/// Examples:
/// <list type="bullet">
/// <item>
/// <term>BinaryData.FromObjectAsJson("foo")</term>
/// <description>Creates a payload of "foo".</description>
/// </item>
/// <item>
/// <term>BinaryData.FromString("\"foo\"")</term>
/// <description>Creates a payload of "foo".</description>
/// </item>
/// <item>
/// <term>BinaryData.FromObjectAsJson(new { key = "value" })</term>
/// <description>Creates a payload of { "key": "value" }.</description>
/// </item>
/// <item>
/// <term>BinaryData.FromString("{\"key\": \"value\"}")</term>
/// <description>Creates a payload of { "key": "value" }.</description>
/// </item>
/// </list>
/// </para>
/// </summary>
private IDictionary<string, BinaryData> _serializedAdditionalRawData;
/// <summary> Initializes a new instance of <see cref="DocumentParagraph"/>. </summary>
/// <param name="content"> Concatenated content of the paragraph in reading order. </param>
/// <param name="spans"> Location of the paragraph in the reading order concatenated content. </param>
/// <exception cref="ArgumentNullException"> <paramref name="content"/> or <paramref name="spans"/> is null. </exception>
internal DocumentParagraph(string content, IEnumerable<DocumentSpan> spans)
{
if (content == null)
{
throw new ArgumentNullException(nameof(content));
}
if (spans == null)
{
throw new ArgumentNullException(nameof(spans));
}
Content = content;
BoundingRegions = new ChangeTrackingList<BoundingRegion>();
Spans = spans.ToList();
}
/// <summary> Initializes a new instance of <see cref="DocumentParagraph"/>. </summary>
/// <param name="role"> Semantic role of the paragraph. </param>
/// <param name="content"> Concatenated content of the paragraph in reading order. </param>
/// <param name="boundingRegions"> Bounding regions covering the paragraph. </param>
/// <param name="spans"> Location of the paragraph in the reading order concatenated content. </param>
/// <param name="serializedAdditionalRawData"> Keeps track of any properties unknown to the library. </param>
internal DocumentParagraph(ParagraphRole? role, string content, IReadOnlyList<BoundingRegion> boundingRegions, IReadOnlyList<DocumentSpan> spans, IDictionary<string, BinaryData> serializedAdditionalRawData)
{
Role = role;
Content = content;
BoundingRegions = boundingRegions;
Spans = spans;
_serializedAdditionalRawData = serializedAdditionalRawData;
}
/// <summary> Initializes a new instance of <see cref="DocumentParagraph"/> for deserialization. </summary>
internal DocumentParagraph()
{
}
/// <summary> Semantic role of the paragraph. </summary>
public ParagraphRole? Role { get; }
/// <summary> Concatenated content of the paragraph in reading order. </summary>
public string Content { get; }
/// <summary> Bounding regions covering the paragraph. </summary>
public IReadOnlyList<BoundingRegion> BoundingRegions { get; }
/// <summary> Location of the paragraph in the reading order concatenated content. </summary>
public IReadOnlyList<DocumentSpan> Spans { get; }
}
}