-
Notifications
You must be signed in to change notification settings - Fork 180
/
AddressValue.yml
182 lines (182 loc) · 4.92 KB
/
AddressValue.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
181
182
### YamlMime:TSType
name: AddressValue
uid: '@azure/ai-form-recognizer.AddressValue'
package: '@azure/ai-form-recognizer'
summary: Address field value.
fullName: AddressValue
remarks: ''
isDeprecated: false
type: interface
properties:
- name: city
uid: '@azure/ai-form-recognizer.AddressValue.city'
package: '@azure/ai-form-recognizer'
summary: Name of city, town, village, etc.
fullName: city
remarks: ''
isDeprecated: false
syntax:
content: 'city?: string'
return:
description: ''
type: string
- name: cityDistrict
uid: '@azure/ai-form-recognizer.AddressValue.cityDistrict'
package: '@azure/ai-form-recognizer'
summary: >-
Districts or boroughs within a city, such as Brooklyn in New York City or
City of Westminster in London.
fullName: cityDistrict
remarks: ''
isDeprecated: false
syntax:
content: 'cityDistrict?: string'
return:
description: ''
type: string
- name: countryRegion
uid: '@azure/ai-form-recognizer.AddressValue.countryRegion'
package: '@azure/ai-form-recognizer'
summary: Country/region.
fullName: countryRegion
remarks: ''
isDeprecated: false
syntax:
content: 'countryRegion?: string'
return:
description: ''
type: string
- name: house
uid: '@azure/ai-form-recognizer.AddressValue.house'
package: '@azure/ai-form-recognizer'
summary: Build name, such as World Trade Center.
fullName: house
remarks: ''
isDeprecated: false
syntax:
content: 'house?: string'
return:
description: ''
type: string
- name: houseNumber
uid: '@azure/ai-form-recognizer.AddressValue.houseNumber'
package: '@azure/ai-form-recognizer'
summary: House or building number.
fullName: houseNumber
remarks: ''
isDeprecated: false
syntax:
content: 'houseNumber?: string'
return:
description: ''
type: string
- name: level
uid: '@azure/ai-form-recognizer.AddressValue.level'
package: '@azure/ai-form-recognizer'
summary: Floor number, such as 3F.
fullName: level
remarks: ''
isDeprecated: false
syntax:
content: 'level?: string'
return:
description: ''
type: string
- name: poBox
uid: '@azure/ai-form-recognizer.AddressValue.poBox'
package: '@azure/ai-form-recognizer'
summary: Post office box number.
fullName: poBox
remarks: ''
isDeprecated: false
syntax:
content: 'poBox?: string'
return:
description: ''
type: string
- name: postalCode
uid: '@azure/ai-form-recognizer.AddressValue.postalCode'
package: '@azure/ai-form-recognizer'
summary: Postal code used for mail sorting.
fullName: postalCode
remarks: ''
isDeprecated: false
syntax:
content: 'postalCode?: string'
return:
description: ''
type: string
- name: road
uid: '@azure/ai-form-recognizer.AddressValue.road'
package: '@azure/ai-form-recognizer'
summary: Street name.
fullName: road
remarks: ''
isDeprecated: false
syntax:
content: 'road?: string'
return:
description: ''
type: string
- name: state
uid: '@azure/ai-form-recognizer.AddressValue.state'
package: '@azure/ai-form-recognizer'
summary: First-level administrative division.
fullName: state
remarks: ''
isDeprecated: false
syntax:
content: 'state?: string'
return:
description: ''
type: string
- name: stateDistrict
uid: '@azure/ai-form-recognizer.AddressValue.stateDistrict'
package: '@azure/ai-form-recognizer'
summary: Second-level administrative division used in certain locales.
fullName: stateDistrict
remarks: ''
isDeprecated: false
syntax:
content: 'stateDistrict?: string'
return:
description: ''
type: string
- name: streetAddress
uid: '@azure/ai-form-recognizer.AddressValue.streetAddress'
package: '@azure/ai-form-recognizer'
summary: >-
Street-level address, excluding city, state, countryRegion, and
postalCode.
fullName: streetAddress
remarks: ''
isDeprecated: false
syntax:
content: 'streetAddress?: string'
return:
description: ''
type: string
- name: suburb
uid: '@azure/ai-form-recognizer.AddressValue.suburb'
package: '@azure/ai-form-recognizer'
summary: Unofficial neighborhood name, like Chinatown.
fullName: suburb
remarks: ''
isDeprecated: false
syntax:
content: 'suburb?: string'
return:
description: ''
type: string
- name: unit
uid: '@azure/ai-form-recognizer.AddressValue.unit'
package: '@azure/ai-form-recognizer'
summary: Apartment or office number
fullName: unit
remarks: ''
isDeprecated: false
syntax:
content: 'unit?: string'
return:
description: ''
type: string