Skip to content

Commit c92ddcc

Browse files
committed
Improve document
1 parent 41a64b4 commit c92ddcc

File tree

2 files changed

+105
-7
lines changed

2 files changed

+105
-7
lines changed

docs/0-Usage-CN.md

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
你可以使用 `pip` 来安装你的依赖。
1414

1515
```sh
16-
$ pip install alibabacloud-imagesearch20200212
16+
$ pip install alibabacloud-ecs20140526
1717
```
1818

1919
## 快速使用
@@ -22,21 +22,70 @@ $ pip install alibabacloud-imagesearch20200212
2222
SDK 使用 [credentials](https://github.com/aliyun/credentials-python/blob/master/README-CN.md) 来管理凭证。
2323

2424
## 使用示例
25+
1.同步使用
26+
```python
27+
from alibabacloud_ecs20140526.models import DescribeImagesRequest
28+
from alibabacloud_ecs20140526.client import Client
29+
from alibabacloud_tea_openapi.models import Config
30+
31+
'''云服务器示例'''
32+
# 初始化Config
33+
config = Config(
34+
access_key_id='',
35+
access_key_secret='',
36+
region_id='cn-hangzhou'
37+
)
38+
client = Client(config)
39+
# 初始化Request
40+
request = DescribeImagesRequest(image_id='')
41+
# 调用api
42+
response = client.describe_images(request)
43+
44+
for image in response.images.image:
45+
print(image.image_id)
46+
print(image.image_name)
47+
```
2548

49+
2.异步使用
50+
```python
51+
import asyncio
52+
53+
from alibabacloud_ecs20140526.models import DescribeImagesRequest
54+
from alibabacloud_ecs20140526.client import Client
55+
from alibabacloud_tea_openapi.models import Config
56+
57+
'''云服务器示例'''
58+
59+
async def main():
60+
config = Config(
61+
access_key_id='',
62+
access_key_secret='',
63+
region_id='cn-hangzhou'
64+
)
65+
client = Client(config)
66+
request = DescribeImagesRequest(image_id='')
67+
68+
response = await client.describe_images_async(request)
69+
print(response)
70+
71+
loop = asyncio.get_event_loop()
72+
loop.run_until_complete(main())
73+
```
74+
75+
3.数据流
2676
```python
2777
from alibabacloud_imagesearch20200212.client import Client
2878
from alibabacloud_imagesearch20200212.models import SearchImageByPicAdvanceRequest
2979
from alibabacloud_oss_util.models import RuntimeOptions
30-
from alibabacloud_tea_rpc.models import Config
80+
from alibabacloud_tea_openapi.models import Config
3181

3282
'''图像搜索示例'''
3383

34-
3584
with open('pic.jpg', 'rb') as f:
3685
# 初始化Request
3786
request = SearchImageByPicAdvanceRequest(
3887
instance_name='name',
39-
pic_content_object=f
88+
pic_content_object=f # 文件流或BytesIO
4089
)
4190

4291
# 初始化Config
@@ -76,7 +125,6 @@ print('all categories:', response.pic_info.all_categories)
76125
for aut in response.auctions:
77126
print('category id:', aut.category_id)
78127
print('product id:', aut.product_id)
79-
80128
```
81129

82130
## 参数说明

docs/0-Usage-EN.md

Lines changed: 52 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,65 @@
1313
If you use `pip` to install your dependence
1414

1515
```sh
16-
$ pip install alibabacloud-imagesearch20200212
16+
$ pip install alibabacloud-ecs20140526
1717
```
1818

1919
## Quick Examples
2020

2121
Before you begin, you need to sign up for an Alibaba Cloud account and retrieve your [Credentials](https://usercenter.console.aliyun.com/#/manage/ak).
2222

2323
## Demo
24+
1.Sync usage
25+
```python
26+
from alibabacloud_ecs20140526.models import DescribeImagesRequest
27+
from alibabacloud_ecs20140526.client import Client
28+
from alibabacloud_tea_openapi.models import Config
29+
30+
'''ECS Example'''
31+
# init Config
32+
config = Config(
33+
access_key_id='',
34+
access_key_secret='',
35+
region_id='cn-hangzhou'
36+
)
37+
client = Client(config)
38+
# init Request
39+
request = DescribeImagesRequest(image_id='')
40+
# call api
41+
response = client.describe_images(request)
42+
43+
for image in response.images.image:
44+
print(image.image_id)
45+
print(image.image_name)
46+
```
47+
48+
2.Async usage
49+
```python
50+
import asyncio
51+
52+
from alibabacloud_ecs20140526.models import DescribeImagesRequest
53+
from alibabacloud_ecs20140526.client import Client
54+
from alibabacloud_tea_openapi.models import Config
55+
56+
'''ECS Example'''
57+
58+
async def main():
59+
config = Config(
60+
access_key_id='',
61+
access_key_secret='',
62+
region_id='cn-hangzhou'
63+
)
64+
client = Client(config)
65+
request = DescribeImagesRequest(image_id='')
66+
67+
response = await client.describe_images_async(request)
68+
print(response)
69+
70+
loop = asyncio.get_event_loop()
71+
loop.run_until_complete(main())
72+
```
2473

74+
3.Stream
2575
```python
2676
from alibabacloud_imagesearch20200212.client import Client
2777
from alibabacloud_imagesearch20200212.models import SearchImageByPicAdvanceRequest
@@ -34,7 +84,7 @@ with open('pic.jpg', 'rb') as f:
3484
# init Request
3585
request = SearchImageByPicAdvanceRequest(
3686
instance_name='name',
37-
pic_content_object=f
87+
pic_content_object=f # File stream or BytesIO
3888
)
3989

4090
# init Config

0 commit comments

Comments
 (0)