Skip to content

Commit 51cf0b9

Browse files
Marat-GumerovMarat-Gumerov
committed
Reference documentation generated
1 parent fbf6e45 commit 51cf0b9

File tree

229 files changed

+5412
-290
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

229 files changed

+5412
-290
lines changed

‎doc/AiBcrApi.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
2+
# AiBcrApi
3+
4+
5+
<a name="parse"></a>
6+
# **parse**
7+
```typescript
8+
public async parse(request: AiBcrParseRequest): Promise< ContactList >
9+
```
10+
11+
Parse images to vCard document models
12+
13+
### Request Parameters
14+
```typescript
15+
new AiBcrParse(
16+
file,
17+
countries=countries,
18+
languages=languages,
19+
isSingle=isSingle)
20+
```
21+
22+
Name | Type | Description | Notes
23+
---- | ---- | ----------- | -----
24+
**file** | **byte[]**| File to parse |
25+
**countries** | **string**| Comma-separated codes of countries. | [optional] [default to ]
26+
**languages** | **string**| Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \&quot;it\&quot; or \&quot;ita\&quot; for Italian); it&#39;s \&quot;\&quot; by default. | [optional] [default to ]
27+
**isSingle** | **boolean**| Determines that image contains single VCard or more. | [optional] [default to true]
28+
29+
### Return type
30+
31+
Promise< [ContactList](ContactList.md) >
32+
33+
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to API README]](README.md)
34+
35+
<a name="parseStorage"></a>
36+
# **parseStorage**
37+
```typescript
38+
public async parseStorage(request: model.AiBcrParseStorageRequest): Promise< StorageFileLocationList >
39+
```
40+
41+
Parse images from storage to vCard files
42+
43+
### request Parameter
44+
45+
See parameter model documentation at [AiBcrParseStorageRequest](AiBcrParseStorageRequest.md)
46+
47+
### Return type
48+
49+
Promise< [StorageFileLocationList](StorageFileLocationList.md) >
50+
51+
[[Back to top]](#) [[Back to Model list]](Models.md) [[Back to API README]](README.md)
52+

‎doc/AiBcrApi_list.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
## Documentation for AiBcrApi
3+
4+
All URIs are relative to *https://api.aspose.cloud/v4.0*
5+
6+
Method | HTTP request | Description
7+
------ | ------------ | -----------
8+
[**parse**](AiBcrApi.md#parse) | **PUT** /email/AiBcr/parse | Parse images to vCard document models
9+
[**parseStorage**](AiBcrApi.md#parseStorage) | **PUT** /email/AiBcr/parse-storage | Parse images from storage to vCard files

‎doc/AiBcrImage.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# AiBcrImage
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**isSingle** | **boolean** | Determines that image contains single VCard or more. | [default to undefined]
8+
9+
10+
11+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AiBcrImageStorageFile.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
2+
# AiBcrImageStorageFile
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**file** | [**StorageFileLocation**](StorageFileLocation.md) | Image location | [default to undefined]
8+
9+
Parent class: [AiBcrImage](AiBcrImage.md)
10+
11+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AiBcrOptions.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
# AiBcrOptions
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**languages** | **string** | Comma-separated ISO-639 codes of languages (either 639-1 or 639-3; i.e. \"it\" or \"ita\" for Italian); it's \"\" by default. | [optional] [default to undefined]
8+
**countries** | **string** | Comma-separated codes of countries. | [optional] [default to undefined]
9+
10+
11+
12+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AiBcrParseStorageRequest.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
# AiBcrParseStorageRequest
3+
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**outFolder** | [**StorageFolderLocation**](StorageFolderLocation.md) | Parse output folder location on storage | [default to undefined]
8+
**images** | [**Array&lt;AiBcrImageStorageFile&gt;**](AiBcrImageStorageFile.md) | Images to parse. | [default to undefined]
9+
**options** | [**AiBcrOptions**](AiBcrOptions.md) | Recognition options. | [optional] [default to undefined]
10+
11+
12+
13+
[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)

‎doc/AiGroup.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# EmailCloud.Ai
2+
AI powered operations.
3+
4+
API | Description
5+
--- | -----------
6+
[EmailCloud.ai.**bcr**](AiBcrApi_list.md) | AI Business card recognition operations.
7+
[EmailCloud.ai.**name**](AiNameApi_list.md) | AI Name operations.

0 commit comments

Comments
 (0)