/
DocumentFieldSchema.yml
72 lines (72 loc) · 2.15 KB
/
DocumentFieldSchema.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
### YamlMime:TSType
name: DocumentFieldSchema
uid: '@azure/ai-form-recognizer.DocumentFieldSchema'
package: '@azure/ai-form-recognizer'
summary: Description of the field semantic schema using a JSON Schema style syntax.
fullName: DocumentFieldSchema
remarks: ''
isDeprecated: false
type: interface
properties:
- name: description
uid: '@azure/ai-form-recognizer.DocumentFieldSchema.description'
package: '@azure/ai-form-recognizer'
summary: Field description.
fullName: description
remarks: ''
isDeprecated: false
syntax:
content: 'description?: string'
return:
description: ''
type: string
- name: example
uid: '@azure/ai-form-recognizer.DocumentFieldSchema.example'
package: '@azure/ai-form-recognizer'
summary: Example field content.
fullName: example
remarks: ''
isDeprecated: false
syntax:
content: 'example?: string'
return:
description: ''
type: string
- name: items
uid: '@azure/ai-form-recognizer.DocumentFieldSchema.items'
package: '@azure/ai-form-recognizer'
summary: Field type schema of each array element.
fullName: items
remarks: ''
isDeprecated: false
syntax:
content: 'items?: DocumentFieldSchema'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.DocumentFieldSchema" />
- name: properties
uid: '@azure/ai-form-recognizer.DocumentFieldSchema.properties'
package: '@azure/ai-form-recognizer'
summary: Named sub-fields of the object field.
fullName: properties
remarks: ''
isDeprecated: false
syntax:
content: 'properties?: {[propertyName: string]: DocumentFieldSchema}'
return:
description: ''
type: >-
{[propertyName: string]: <xref
uid="@azure/ai-form-recognizer.DocumentFieldSchema" />}
- name: type
uid: '@azure/ai-form-recognizer.DocumentFieldSchema.type'
package: '@azure/ai-form-recognizer'
summary: Semantic data type of the field value.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type: string'
return:
description: ''
type: string