byteplus-rec 1.0.10
SDK for byteplus rec
License: Apache 2.0
Requires Python: >=3

## byteplus rec python sdk

#### Install the client library
```shell
pip install --upgrade byteplus-rec
```

#### Saas E-Commerce Example
```python
from byteplus_rec.region.region import Region
from byteplus_rec.retail.retail_client import Client
from byteplus_rec.retail.retail_client_builder import ClientBuilder
from byteplus_rec_core.exception import BizException

log = logging.getLogger(__name__)

# A unique identity assigned by Bytedance.
PROJECT_ID = "***********"

# Unique id for this model.The saas model id that can be used to get rec results from predict api,
# which is need to fill in URL.
MODEL_ID = "***********"

# Required Param:
#       tenant_id
#       region
#       AK
#       SK
# Optional Param:
#       scheme
#       hosts
try:
    client: Client = ClientBuilder() \
        .account_id("***********") \
        .region(Region.SG) \
        .project_id(PROJECT_ID) \
        .auth_ak("***********") \
        .auth_sk("***********") \
        .build()
except BizException as clientE:
    log.error("fail to create byteplus rec client, msg:%s", clientE)

if __name__ == '__main__':
    client.write_users()
    client.predict()
```

#### Saas Content(Short-Video/Image/Doc) Example
```python
from byteplus_rec.region.region import Region
from byteplus_rec.content.content_client import Client
from byteplus_rec.content.content_client_builder import ClientBuilder
from byteplus_rec_core.exception import BizException

log = logging.getLogger(__name__)

# A unique identity assigned by Bytedance.
PROJECT_ID = "***********"

# Unique id for this model.The saas model id that can be used to get rec results from predict api,
# which is need to fill in URL.
MODEL_ID = "***********"

# Required Param:
#       tenant_id
#       region
#       AK
#       SK
# Optional Param:
#       scheme
#       hosts
try:
    client: Client = ClientBuilder() \
        .account_id("***********") \
        .region(Region.SG) \
        .project_id(PROJECT_ID) \
        .auth_ak("***********") \
        .auth_sk("***********") \
        .build()
except BizException as clientE:
    log.error("fail to create byteplus rec client, msg:%s", clientE)

if __name__ == '__main__':
    client.write_users()
    client.predict()
```

#### How to run example
Take the E-commerce industry as an example:
* clone the project.
* install requirements.
* add sdk root path to envs.
* enter the example directory.
* fill necessary parameters.
* run main.py.

```shell
git clone https://github.com/byteplus-sdk/byteplus-sdk-python-rec.git
cd byteplus-sdk-python-rec
pip3 install -r requirements.txt
export PYTHONPATH=$PYTHONPATH:$PWD
cd byteplus_rec/retail/example
# fill in projectID, modelID, tenantID, AK, SK and other parameters.
python3 main.py
```

#### For more details
* [Saas E-Commerce Code Sample](https://docs.byteplus.com/en/recommend/samples/retail_code_samples)
* [Saas E-Commerce API Reference](https://docs.byteplus.com/en/recommend/reference/retail_saas_writeusers)
* [Saas Content Code Sample](https://docs.byteplus.com/en/recommend/samples/content_code_samples)
* [Saas Content API Reference](https://docs.byteplus.com/en/recommend/reference/content_saas_writeusers)