-
Notifications
You must be signed in to change notification settings - Fork 257
/
CustomFormModel.xml
229 lines (229 loc) · 12.7 KB
/
CustomFormModel.xml
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<Type Name="CustomFormModel" FullName="Azure.AI.FormRecognizer.Training.CustomFormModel">
<TypeSignature Language="C#" Value="public class CustomFormModel" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CustomFormModel extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.FormRecognizer.Training.CustomFormModel" />
<TypeSignature Language="VB.NET" Value="Public Class CustomFormModel" />
<TypeSignature Language="F#" Value="type CustomFormModel = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>3.0.1.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>3.1.1.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a model trained from custom forms.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Errors">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormRecognizerError> Errors { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<class Azure.AI.FormRecognizer.Models.FormRecognizerError> Errors" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.Training.CustomFormModel.Errors" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Errors As IReadOnlyList(Of FormRecognizerError)" />
<MemberSignature Language="F#" Value="member this.Errors : System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormRecognizerError>" Usage="Azure.AI.FormRecognizer.Training.CustomFormModel.Errors" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Models.FormRecognizerError></ReturnType>
</ReturnValue>
<Docs>
<summary>
A list of errors occurred during the training operation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ModelId">
<MemberSignature Language="C#" Value="public string ModelId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ModelId" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.Training.CustomFormModel.ModelId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ModelId As String" />
<MemberSignature Language="F#" Value="member this.ModelId : string" Usage="Azure.AI.FormRecognizer.Training.CustomFormModel.ModelId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The unique identifier of this model.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ModelName">
<MemberSignature Language="C#" Value="public string ModelName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ModelName" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.Training.CustomFormModel.ModelName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ModelName As String" />
<MemberSignature Language="F#" Value="member this.ModelName : string" Usage="Azure.AI.FormRecognizer.Training.CustomFormModel.ModelName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
An optional, user-defined name to associate with your model.
</summary>
<value>To be added.</value>
<remarks>
This property only has value for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" /> and newer.
</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public Azure.AI.FormRecognizer.Training.CustomFormModelProperties Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.AI.FormRecognizer.Training.CustomFormModelProperties Properties" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.Training.CustomFormModel.Properties" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Properties As CustomFormModelProperties" />
<MemberSignature Language="F#" Value="member this.Properties : Azure.AI.FormRecognizer.Training.CustomFormModelProperties" Usage="Azure.AI.FormRecognizer.Training.CustomFormModel.Properties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Training.CustomFormModelProperties</ReturnType>
</ReturnValue>
<Docs>
<summary>
Properties of a model, such as whether the model is a composed model or not.
</summary>
<value>To be added.</value>
<remarks>
This property only has value for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" /> and newer.
</remarks>
</Docs>
</Member>
<Member MemberName="Status">
<MemberSignature Language="C#" Value="public Azure.AI.FormRecognizer.Training.CustomFormModelStatus Status { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Azure.AI.FormRecognizer.Training.CustomFormModelStatus Status" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.Training.CustomFormModel.Status" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Status As CustomFormModelStatus" />
<MemberSignature Language="F#" Value="member this.Status : Azure.AI.FormRecognizer.Training.CustomFormModelStatus" Usage="Azure.AI.FormRecognizer.Training.CustomFormModel.Status" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Training.CustomFormModelStatus</ReturnType>
</ReturnValue>
<Docs>
<summary>
A status indicating this model's readiness for use.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Submodels">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Training.CustomFormSubmodel> Submodels { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<class Azure.AI.FormRecognizer.Training.CustomFormSubmodel> Submodels" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.Training.CustomFormModel.Submodels" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Submodels As IReadOnlyList(Of CustomFormSubmodel)" />
<MemberSignature Language="F#" Value="member this.Submodels : System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Training.CustomFormSubmodel>" Usage="Azure.AI.FormRecognizer.Training.CustomFormModel.Submodels" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Training.CustomFormSubmodel></ReturnType>
</ReturnValue>
<Docs>
<summary>
A list of submodels that are part of this model, each of which can recognize and extract fields from a different type of form.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TrainingCompletedOn">
<MemberSignature Language="C#" Value="public DateTimeOffset TrainingCompletedOn { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset TrainingCompletedOn" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.Training.CustomFormModel.TrainingCompletedOn" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TrainingCompletedOn As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.TrainingCompletedOn : DateTimeOffset" Usage="Azure.AI.FormRecognizer.Training.CustomFormModel.TrainingCompletedOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
The date and time (UTC) when model training completed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TrainingDocuments">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Training.TrainingDocumentInfo> TrainingDocuments { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IReadOnlyList`1<class Azure.AI.FormRecognizer.Training.TrainingDocumentInfo> TrainingDocuments" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.Training.CustomFormModel.TrainingDocuments" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TrainingDocuments As IReadOnlyList(Of TrainingDocumentInfo)" />
<MemberSignature Language="F#" Value="member this.TrainingDocuments : System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Training.TrainingDocumentInfo>" Usage="Azure.AI.FormRecognizer.Training.CustomFormModel.TrainingDocuments" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.Training.TrainingDocumentInfo></ReturnType>
</ReturnValue>
<Docs>
<summary>
A list of meta-data about each of the documents used to train the model.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TrainingStartedOn">
<MemberSignature Language="C#" Value="public DateTimeOffset TrainingStartedOn { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset TrainingStartedOn" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.Training.CustomFormModel.TrainingStartedOn" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TrainingStartedOn As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.TrainingStartedOn : DateTimeOffset" Usage="Azure.AI.FormRecognizer.Training.CustomFormModel.TrainingStartedOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
The date and time (UTC) when model training was started.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>