What is the endpoint for LOC Predict(Beta)?

The LOC Predict(Beta) endpoint is POST https://connect.patsnap.com/ai/image/loc_predict.

What data can LOC Predict(Beta) return?

LOC Predict(Beta) LOC and keywords are predicted by uploading image url and description. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for LOC Predict(Beta)?

The OpenAPI schema is available at /openapi.json#/paths/~1ai~1image~1loc_predict/post. You can also browse the full specification at /openapi.json.

LOC Predict(Beta)

post

https://connect.patsnap.com/ai/image/loc_predict

Try in Sandbox

LOC and keywords are predicted by uploading image url and description.

1、Support JPG and PNG, File size limit is 4MB

2、Product description is recommended to help improve prediction accuracy.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`description`	`string`	`一款智能触屏手机`	Product Description
`url` Required	`string`	`https://static-open.zhihuiya.com/sample/common_demo.png`	image url

{
  "url": "https://static-open.zhihuiya.com/sample/common_demo.png",
  "description": "一款智能触屏手机"
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`loc`	`array`	`[ { "loc": "14-03", "desc": "电信设备、无线遥控设备和无线电放大器", "score": "0.89" } ]`	Predicted LOC
`loc`	`string`	`14-03`	LOC code
`desc`	`string`	`电信设备、无线遥控设备和无线电放大器（注:包括电话和电视设备，以及无线电设备。）`	LOC Description
`score`	`number`	`0.89`	score
`keywords`	`array`	`[ "手机", "屏幕", "phone", "mobile phone", "phone case" ]`	Keywords
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": {
    "loc": [
      {
        "loc": "14-03",
        "desc": "电信设备、无线遥控设备和无线电放大器 （注:包括电话和电视设备，以及无线电设备。）",
        "score": 0.89
      }
    ],
    "keywords": [
      "手机",
      "屏幕",
      "phone",
      "mobile phone",
      "phone case"
    ]
  },
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200000`	API call exceeds the total limit set by the platform!
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	The current call rate is too fast, exceeding the current configuration limit QPS!
`67200003`	The key and secret parameters for applying for the token are incorrect or the client has been disabled!
`67200004`	The requested api does not have permission. Please contact our support personnel!
`67200005`	Insufficient account balance/number of calls!
`67200006`	The client has exceeded the activation validity period!
`67200007`	The current call exceeds the configured usage limit of the day!
`67200008`	Please check if the required apikey in the query parameter has been transmitted!
`67200009`	The apikey does not match the passed bearerToken. Please check if a valid token is being used!
`67200012`	The request is illegal!
`67200100`	The current server status is busy, request response timeout!
`67200101`	The API requested currently does not exist. Please check the request path!

HTTP Status Codes

Status Code	Description
`0`	Success
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms