商品检索服务提供的所有接口具有统一的接口格式。此外,对于公共用户和已开通OSS的用户,调用接口时需要遵守的规则不同。本文介绍商品检索服务提供的所有接口的通用参数及不同用户调用接口的差异性。

POST接口

  • 接口格式
    您可以通过POST相关字段调用商品检索服务提供的所有接口,接口的统一格式如下所示。
    {   
        "db_name" : "XXX" #可选,区分服务层调用和数据库层调用。如果未指定,则调用数据库管理层接口。
        "function_name": "XXX"  #必选,调用接口的名称。
        "function_params": {
            param1: XXX #参考不同接口对应的参数说明。
            param2:
            ....
        },
     }
  • 输入参数
    参数 是否必选 描述 Type
    db_name 服务可以通过POST操作数据库管理层或单个数据库,如果指定db_name,则操作指定数据库,否则操作数据库管理层。 STRING
    function_name
    • 如果未指定,即操作数据库管理层,则取值包括initsetgetdeleteaddsave
    • 如果指定了db_name,即操作单个数据库,则取值包括setgetsearchdeleteclean
    STRING
    function_params 不同function_name的要求不同 请参考function_name对应的接口说明。 DICT
  • 返回参数

    请参考function_name对应的接口说明文档。

不同用户调用接口的差异性

如果您未开通OSS服务,则部署模型服务后,必须执行数据库管理层的init函数,以获取唯一的uid_key,且所有数据库管理层的adddelete操作都必选提供该uid_key

果您已开通OSS服务,则可以通过set函数设置自己的OSS,之后的操作无需uiduid_key,详细请参见开通OSS后的特有接口