-
Notifications
You must be signed in to change notification settings - Fork 180
/
CreateDocumentModelOptions.yml
180 lines (178 loc) · 6.76 KB
/
CreateDocumentModelOptions.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
176
177
178
179
180
### YamlMime:TSType
name: CreateDocumentModelOptions
uid: '@azure/ai-form-recognizer.CreateDocumentModelOptions'
package: '@azure/ai-form-recognizer'
summary: Options for the model creation operation.
fullName: CreateDocumentModelOptions
remarks: ''
isDeprecated: false
type: interface
inheritedProperties:
- name: abortSignal
uid: '@azure/ai-form-recognizer.CreateDocumentModelOptions.abortSignal'
package: '@azure/ai-form-recognizer'
summary: The signal which can be used to abort requests.
fullName: abortSignal
remarks: ''
isDeprecated: false
syntax:
content: 'abortSignal?: AbortSignalLike'
return:
description: ''
type: <xref uid="@azure/abort-controller.AbortSignalLike" />
inheritanceDescription: >-
<b>Inherited From</b>
[PollerOptions.abortSignal](xref:@azure/ai-form-recognizer.PollerOptions.abortSignal)
- name: description
uid: '@azure/ai-form-recognizer.CreateDocumentModelOptions.description'
package: '@azure/ai-form-recognizer'
summary: A textual description of the model (can be any text).
fullName: description
remarks: ''
isDeprecated: false
syntax:
content: 'description?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[CommonModelCreationOptions.description](xref:@azure/ai-form-recognizer.CommonModelCreationOptions.description)
- name: onProgress
uid: '@azure/ai-form-recognizer.CreateDocumentModelOptions.onProgress'
package: '@azure/ai-form-recognizer'
summary: >-
An optional initial progress handler that will be called when the poller
state updates. This handler will be called
once immediately after the poller state is initialized.
fullName: onProgress
remarks: ''
isDeprecated: false
syntax:
content: 'onProgress?: (state: DocumentModelOperationState) => void'
return:
description: ''
type: '(state: DocumentModelOperationState) => void'
inheritanceDescription: >-
<b>Inherited From</b>
[PollerOptions.onProgress](xref:@azure/ai-form-recognizer.PollerOptions.onProgress)
- name: onResponse
uid: '@azure/ai-form-recognizer.CreateDocumentModelOptions.onResponse'
package: '@azure/ai-form-recognizer'
summary: |-
A function to be called each time a response is received from the server
while performing the requested operation.
May be called multiple times.
fullName: onResponse
remarks: ''
isDeprecated: false
syntax:
content: 'onResponse?: RawResponseCallback'
return:
description: ''
type: <xref uid="@azure/core-client.RawResponseCallback" />
inheritanceDescription: >-
<b>Inherited From</b>
[PollerOptions.onResponse](xref:@azure/ai-form-recognizer.PollerOptions.onResponse)
- name: requestOptions
uid: '@azure/ai-form-recognizer.CreateDocumentModelOptions.requestOptions'
package: '@azure/ai-form-recognizer'
summary: Options used when creating and sending HTTP requests for this operation.
fullName: requestOptions
remarks: ''
isDeprecated: false
syntax:
content: 'requestOptions?: OperationRequestOptions'
return:
description: ''
type: <xref uid="@azure/core-client.OperationRequestOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[PollerOptions.requestOptions](xref:@azure/ai-form-recognizer.PollerOptions.requestOptions)
- name: resumeFrom
uid: '@azure/ai-form-recognizer.CreateDocumentModelOptions.resumeFrom'
package: '@azure/ai-form-recognizer'
summary: >-
A serialized poller state. If provided, the polling operation will be
resumed from the given state instead of
started as if it were a new operation.
fullName: resumeFrom
remarks: ''
isDeprecated: false
syntax:
content: 'resumeFrom?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[PollerOptions.resumeFrom](xref:@azure/ai-form-recognizer.PollerOptions.resumeFrom)
- name: serializerOptions
uid: '@azure/ai-form-recognizer.CreateDocumentModelOptions.serializerOptions'
package: '@azure/ai-form-recognizer'
summary: Options to override serialization/de-serialization behavior.
fullName: serializerOptions
remarks: ''
isDeprecated: false
syntax:
content: 'serializerOptions?: SerializerOptions'
return:
description: ''
type: <xref uid="@azure/core-client.SerializerOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[PollerOptions.serializerOptions](xref:@azure/ai-form-recognizer.PollerOptions.serializerOptions)
- name: tags
uid: '@azure/ai-form-recognizer.CreateDocumentModelOptions.tags'
package: '@azure/ai-form-recognizer'
summary: >-
Additional, user-specified key-value pairs to associate with the model as
persistent metadata.
fullName: tags
remarks: ''
isDeprecated: false
syntax:
content: 'tags?: Record<string, string>'
return:
description: ''
type: Record<string, string>
inheritanceDescription: >-
<b>Inherited From</b>
[CommonModelCreationOptions.tags](xref:@azure/ai-form-recognizer.CommonModelCreationOptions.tags)
- name: tracingOptions
uid: '@azure/ai-form-recognizer.CreateDocumentModelOptions.tracingOptions'
package: '@azure/ai-form-recognizer'
summary: Options used when tracing is enabled.
fullName: tracingOptions
remarks: ''
isDeprecated: false
syntax:
content: 'tracingOptions?: OperationTracingOptions'
return:
description: ''
type: <xref uid="@azure/core-tracing.OperationTracingOptions" />
inheritanceDescription: >-
<b>Inherited From</b>
[PollerOptions.tracingOptions](xref:@azure/ai-form-recognizer.PollerOptions.tracingOptions)
- name: updateIntervalInMs
uid: '@azure/ai-form-recognizer.CreateDocumentModelOptions.updateIntervalInMs'
package: '@azure/ai-form-recognizer'
summary: >-
The amount of time to wait (in milliseconds) between subsequent requests
relating to the same operation.
fullName: updateIntervalInMs
remarks: ''
isDeprecated: false
syntax:
content: 'updateIntervalInMs?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[PollerOptions.updateIntervalInMs](xref:@azure/ai-form-recognizer.PollerOptions.updateIntervalInMs)
extends: >-
<xref uid="@azure/core-client.OperationOptions" />,<xref
uid="@azure/ai-form-recognizer.CommonModelCreationOptions" />,<xref
uid="@azure/ai-form-recognizer.PollerOptions" /><<xref
uid="@azure/ai-form-recognizer.DocumentModelOperationState" />>