Skip to content

Latest commit

 

History

History
420 lines (258 loc) · 8.96 KB

README.rst

File metadata and controls

420 lines (258 loc) · 8.96 KB

ProductAI SDK for Python

https://travis-ci.org/MalongTech/productai-python-sdk.svg?branch=master

ProductAI® SDKs enable using ProductAI® APIs easily in the programming language of your choice. You can use our Python SDK to send image queries and maintain your datasets.

installation

$ pip install productai

Quick start

Add single image to image set

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
resp = api.add_image(url, meta, tags='cartoon|square')

Batch add images to image set

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
with open('images.csv') as f:
    res = api.add_images_in_bulk(f)

Remove images from image set

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
with open("images.csv") as f:
    resp = api.delete_images_in_bulk(f)

Create new image set

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_creating_api()
resp = api.create_image_set(name='xxx', description='xxx')

Get image set info

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
resp = api.get_image_set()

Update image set name and/or description

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
resp = api.update_image_set(name="xxx")
or
resp = api.update_image_set(description="xxx")
or
resp = api.update_image_set(name="xxx", description="xxx")

Delete image set

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
resp = api.delete_image_set()

Create customer service

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
# scenario must be supported by system
resp = api.create_service(name='xxx', scenario='fashion')

Search images

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_search_api(service_id)

# query by url of image
resp = api.query(image_url)

# or query by local image
with open("fashion.jpg") as f_image:
    resp = api.query(f_image)

# Specifies the maximum number of results, defaults is 20
# Specifies the result containing 'MALE' and 'SHOES' tags
resp = api.query(image_url, count=10, tags=['MALE', 'SHOES'])

# use string as tag search. "|" equals to "and"
resp = api.query(image_url, count=10, tags='MALE|SHOES')

# use the complex form of tag search
resp = api.query(image_url, count=10, tags={'and': ['MALE', 'SHOES', {'or': ['TMALL', 'TAOBAO']}]})

Get customer service info

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_customer_service_api(service_id)
resp = api.get_service()

Update customer service name

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_customer_service_api(service_id)
resp = api.update_service("xxx")

Delete customer service

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_customer_service_api(service_id)
resp = api.delete_service()

Use other service

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_api(service_type, service_id)
resp = api.query(image_url)

Set URL_ROOT

from productai import Client

# default value is: https://api.productai.cn
cli = Client(access_key_id, access_key_secret, url_root='https://api-bj.productai.cn')
or
cli = Client(access_key_id, access_key_secret)
cli.url_root = 'https://api-bj.productai.cn'

安装

$ pip install productai

快速入门

添加图片到图集

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
resp = api.add_image(url, meta, tags='卡通|四方')

批量添加图片到图集

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
with open('images.csv') as f:
    res = api.add_images_in_bulk(f)

删除图集中的图片

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
with open("images.csv") as f:
    resp = api.delete_images_in_bulk(f)

创建新图集

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_creating_api()
resp = api.create_image_set(name='xxx', description='xxx')

查看图集信息

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
resp = api.get_image_set()

更新图集名字和/或描述

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
resp = api.update_image_set(name="xxx")
or
resp = api.update_image_set(description="xxx")
or
resp = api.update_image_set(name="xxx", description="xxx")

删除图集

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
resp = api.delete_image_set()

创建自建服务

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_set_api(image_set_id)
# scenario 必须是系统支持的名字
resp = api.create_service(name='xxx', scenario='fashion')

搜索图片

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_image_search_api(service_id)

# 用图片URL查询
resp = api.query(image_url)

# 或者直接上传本地图片查询
with open("fashion.jpg") as f_image:
    resp = api.query(f_image)

# 指定查询结果数量上限，默认为 20
# 指定查询结果必须有MALE和SHOES标签
resp = api.query(image_url, count=10, tags=['MALE', 'SHOES'])

# 也可以按如下方式创建标签搜索，"|"等价于"and"操作符
resp = api.query(image_url, count=10, tags='MALE|SHOES')

# 或者使用复杂标签搜索
resp = api.query(image_url, count=10, tags={'and': ['MALE', 'SHOES', {'or': ['TMALL', 'TAOBAO']}]})

获取自建服务信息

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_customer_service_api(service_id)
resp = api.get_service()

更新自建服务名字

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_customer_service_api(service_id)
resp = api.update_service("xxx")

删除自建服务

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_customer_service_api(service_id)
resp = api.delete_service()

使用其他服务

from productai import Client

cli = Client(access_key_id, access_key_secret)
api = cli.get_api(service_type, service_id)
resp = api.query(image_url)

设置 URL_ROOT

from productai import Client

# 默认值为: https://api.productai.cn
cli = Client(access_key_id, access_key_secret, url_root='https://api-bj.productai.cn')
or
cli = Client(access_key_id, access_key_secret)
cli.url_root = 'https://api-bj.productai.cn'