/
DocumentModelBuildOperationDetails.yml
175 lines (175 loc) · 5.98 KB
/
DocumentModelBuildOperationDetails.yml
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
### YamlMime:TSType
name: DocumentModelBuildOperationDetails
uid: '@azure/ai-form-recognizer.DocumentModelBuildOperationDetails'
package: '@azure/ai-form-recognizer'
summary: Get Operation response object.
fullName: DocumentModelBuildOperationDetails
remarks: ''
isDeprecated: false
type: interface
properties:
- name: kind
uid: '@azure/ai-form-recognizer.DocumentModelBuildOperationDetails.kind'
package: '@azure/ai-form-recognizer'
summary: >-
Polymorphic discriminator, which specifies the different types this object
can be
fullName: kind
remarks: ''
isDeprecated: false
syntax:
content: 'kind: "documentModelBuild"'
return:
description: ''
type: '"documentModelBuild"'
- name: result
uid: '@azure/ai-form-recognizer.DocumentModelBuildOperationDetails.result'
package: '@azure/ai-form-recognizer'
summary: Operation result upon success.
fullName: result
remarks: ''
isDeprecated: false
syntax:
content: 'result?: DocumentModelDetails'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.DocumentModelDetails" />
inheritedProperties:
- name: apiVersion
uid: '@azure/ai-form-recognizer.DocumentModelBuildOperationDetails.apiVersion'
package: '@azure/ai-form-recognizer'
summary: API version used to create this operation.
fullName: apiVersion
remarks: ''
isDeprecated: false
syntax:
content: 'apiVersion?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[OperationDetails.apiVersion](xref:@azure/ai-form-recognizer.OperationDetails.apiVersion)
- name: createdOn
uid: '@azure/ai-form-recognizer.DocumentModelBuildOperationDetails.createdOn'
package: '@azure/ai-form-recognizer'
summary: Date and time (UTC) when the operation was created.
fullName: createdOn
remarks: ''
isDeprecated: false
syntax:
content: 'createdOn: Date'
return:
description: ''
type: Date
inheritanceDescription: >-
<b>Inherited From</b>
[OperationDetails.createdOn](xref:@azure/ai-form-recognizer.OperationDetails.createdOn)
- name: error
uid: '@azure/ai-form-recognizer.DocumentModelBuildOperationDetails.error'
package: '@azure/ai-form-recognizer'
summary: Encountered error.
fullName: error
remarks: ''
isDeprecated: false
syntax:
content: 'error?: ErrorModel'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.ErrorModel" />
inheritanceDescription: >-
<b>Inherited From</b>
[OperationDetails.error](xref:@azure/ai-form-recognizer.OperationDetails.error)
- name: lastUpdatedOn
uid: '@azure/ai-form-recognizer.DocumentModelBuildOperationDetails.lastUpdatedOn'
package: '@azure/ai-form-recognizer'
summary: Date and time (UTC) when the status was last updated.
fullName: lastUpdatedOn
remarks: ''
isDeprecated: false
syntax:
content: 'lastUpdatedOn: Date'
return:
description: ''
type: Date
inheritanceDescription: >-
<b>Inherited From</b>
[OperationDetails.lastUpdatedOn](xref:@azure/ai-form-recognizer.OperationDetails.lastUpdatedOn)
- name: operationId
uid: '@azure/ai-form-recognizer.DocumentModelBuildOperationDetails.operationId'
package: '@azure/ai-form-recognizer'
summary: Operation ID
fullName: operationId
remarks: ''
isDeprecated: false
syntax:
content: 'operationId: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[OperationDetails.operationId](xref:@azure/ai-form-recognizer.OperationDetails.operationId)
- name: percentCompleted
uid: >-
@azure/ai-form-recognizer.DocumentModelBuildOperationDetails.percentCompleted
package: '@azure/ai-form-recognizer'
summary: Operation progress (0-100).
fullName: percentCompleted
remarks: ''
isDeprecated: false
syntax:
content: 'percentCompleted?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[OperationDetails.percentCompleted](xref:@azure/ai-form-recognizer.OperationDetails.percentCompleted)
- name: resourceLocation
uid: >-
@azure/ai-form-recognizer.DocumentModelBuildOperationDetails.resourceLocation
package: '@azure/ai-form-recognizer'
summary: URL of the resource targeted by this operation.
fullName: resourceLocation
remarks: ''
isDeprecated: false
syntax:
content: 'resourceLocation: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[OperationDetails.resourceLocation](xref:@azure/ai-form-recognizer.OperationDetails.resourceLocation)
- name: status
uid: '@azure/ai-form-recognizer.DocumentModelBuildOperationDetails.status'
package: '@azure/ai-form-recognizer'
summary: Operation status.
fullName: status
remarks: ''
isDeprecated: false
syntax:
content: 'status: OperationStatus'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.OperationStatus" />
inheritanceDescription: >-
<b>Inherited From</b>
[OperationDetails.status](xref:@azure/ai-form-recognizer.OperationDetails.status)
- name: tags
uid: '@azure/ai-form-recognizer.DocumentModelBuildOperationDetails.tags'
package: '@azure/ai-form-recognizer'
summary: List of key-value tag attributes associated with the document model.
fullName: tags
remarks: ''
isDeprecated: false
syntax:
content: 'tags?: {[propertyName: string]: string}'
return:
description: ''
type: '{[propertyName: string]: string}'
inheritanceDescription: >-
<b>Inherited From</b>
[OperationDetails.tags](xref:@azure/ai-form-recognizer.OperationDetails.tags)
extends: <xref uid="@azure/ai-form-recognizer.OperationDetails" />