对于已开通OSS的用户,商品检索服务支持额外的接口。本文介绍这些额外接口的详细信息,包括POST内容示例、输入参数、输出参数及输出示例。

对于已经开通OSS的用户,商品检索服务还支持以下功能:
  • 通过set命令设置服务默认的OSS信息,设置完成后,可以将数据库内容和原始数据存储到自己的OSS中。
  • 完成OSS设置后,数据库管理层中的adddelete等指令无需使用uiduid_key,且数据库数目和单个数据库记录数无上限限制。
  • 完成OSS设置后,您可以对指定数据库使用loadsave操作,完成单个数据库的存储和加载。
  • 完成OSS设置后,您注册和检索的图片URL支持OSS链接。
以下详细介绍这些接口的具体信息。

数据库管理层:设置(set)

  • POST内容示例
    {
        "function_name": "set",
        "function_params": {
             "oss_io_config" : {
              'ak_id':'xxxxxx',
                  'ak_secret':'xxxxxxxxx',
                  'hosts':'oss-cn-xxxx.com',
                  'buckets':['xxxa','xxxb']
              },
         "oss_data_dir" :"oss://pxxxxxxx/est"
         },
    }
  • 请求参数说明
    参数 描述 是否必选 类型
    oss_io_config ak_id 阿里云账号的AccessKey ID。
    说明 需要对oss_data_dir目录有读取权限。
    STRING
    ak_secret 阿里云账号的AccessKey Secret。 STRING
    hosts OSS Host信息。 STRING
    buckets OSS Bucket信息,服务的所有原始数据和持久化后的数据库存储地址。 STRING
    oss_data_dir 原始数据的存放地址,数据库a的所有数据会存放在oss_data_dir/a目录下。 STRING
  • 返回参数说明
    参数 描述 类型
    request_id 请求的唯一标识。 STRING
    success 请求是否成功,取值如下:
    • true:请求成功。
    • false:请求失败。
    BOOL
    db_dict 成功设置后,返回服务当前的数据库信息,与get的返回相同。 STRING
    error_code 请求失败时,返回的错误码。 INT
    error_msg 请求失败时,返回的错误信息。 STRING
  • 返回示例
    {
        "request_id": "aed21207-b946-4e66-ab87-190dae48****", 
        "success": true, 
        "db_dict": {"oss_hz": {"name": "oss_hz", "record_num": 3, "groupid_num": 1, "database_save_path": "oss://xxxxxx/xxxx/a6c3ac07c9c33187f2ec9bf04e72****/oss_hz/RDB.pkl"}}
    }

数据库层:存储(save)/加载(load)

  • POST内容示例
    {
        "db_name": "oss_hz",
        "function_name": "save", # 可以替换为load。
        "function_params": {
            "path" : "oss://xxxxx/RDB.pkl"
        },
     }
  • 输入参数说明
    参数 描述 是否必选 类型
    path 存储地址 STRING
  • 返回参数说明
    参数 描述 类型
    request_id 请求的唯一标识。 STRING
    success 请求是否成功,取值如下:
    • true:请求成功。
    • false:请求失败。
    BOOL
    load 加载是否成功,取值如下:
    • true:加载成功。
    • false:加载失败。
    BOOL
    error_code 请求失败时,返回的错误码。 INT
    error_msg 请求失败时,返回的错误信息。 STRING
  • 返回示例
    {
        "request_id": "08bb72fb-112b-4d19-9709-398618c0****", 
        "success": true, 
        "load": true
    }