提交新的Landscape作业的接口地址是什么？

提交新的Landscape作业的接口为 POST https://connect.zhihuiya.com/landscape-api/jobs。

提交新的Landscape作业可以返回哪些数据？

提交新的Landscape作业：创建一个新的Landscape分析作业，处理专利集合。。完整响应结构请参见本页的响应结构与成功响应示例。

在哪里可以找到提交新的Landscape作业的 OpenAPI schema？

OpenAPI schema 位于 /openapi.json#/paths/~1landscape-api~1jobs/post，也可在 /openapi.json 浏览完整规范。

提交新的Landscape作业

Q: 提交新的Landscape作业 的接口地址是什么？

提交新的Landscape作业 的接口为 POST https://connect.zhihuiya.com/landscape-api/jobs。

post

https://connect.zhihuiya.com/landscape-api/jobs

在体验中心中试用

创建一个新的Landscape分析作业，处理专利集合。

作业创建后会被异步处理

请求参数

此 API 接口支持的参数列表

名称	类型	示例	描述
`browser_uri`	`string`	`https://example.com/search?q=electric+vehicle`	浏览器URI，原始请求的浏览器链接
`dashboard_id`	`string`	`dashboard123`	仪表盘ID，关联的仪表盘标识
`description`	`string`	`Analysis of electric vehicle technologies`	描述，作业的详细描述
`exclude_expired_patent`	`boolean`	-	是否排除过期专利
`expired_collapse`	`boolean`	`true`	是否过滤过期专利
`filter_query`	`string`	`assignee:(Tesla)`	过滤查询条件，用于筛选结果
`gid`	`array`	`[ "group1", "group2" ]`	组ID列表，标识用户所属的组
`job_id` 必填	`string`	`landscape_job_12345`	作业ID，唯一标识Landscape作业
`lang`	`string`	`en`	语言，指定结果的语言
`match`	`array`	`[ { "text": "artificial intelligence", "field": "title", "weight": 0.8 } ]`	匹配项列表，用于文本匹配分析
`description`	`string`	`Advanced technologies for electric vehicle batteries`	描述，匹配项的详细描述
`digest_text`	`string`	`Electric vehicle battery technology`	摘要文本，匹配项的文本摘要
`title` 必填	`string`	`Electric vehicle battery technology`	标题，匹配项的标题信息
`oq`	`string`	`battery`	其他查询字符串，补充的搜索条件
`par_job_id`	`string`	`job123`	父作业ID，关联的上级作业
`q` 必填	`string`	`electric vehicle`	查询字符串，主要搜索条件
`request_type` 必填	`string`	`som`	请求类型，指定Landscape作业的处理类型
`rows`	`integer<int32>`	`100`	行数，指定返回结果集的大小
`stemming`	`boolean`	`true`	是否使用词干提取，影响搜索的文本处理
`time_slices`	`string`	`year`	时间切片，指定时间范围的切分方式
`time_start`	`string`	`2010-01-01`	开始时间，分析的时间范围起点
`time_stop`	`string`	`2020-12-31`	结束时间，分析的时间范围终点
`time_type`	`string`	`filing_date`	时间类型，指定使用的时间字段类型
`title`	`string`	`Electric Vehicle Landscape Analysis`	标题，作业的标题描述
`uid` 必填	`string`	`user123`	用户ID，标识请求的用户

请求示例

该 API 接口的请求体示例

JSON

{
  "q": "electric vehicle",
  "oq": "battery",
  "gid": [
    "group1",
    "group2"
  ],
  "uid": "user123",
  "lang": "en",
  "rows": 100,
  "match": [
    {
      "title": "Electric vehicle battery technology",
      "description": "Advanced technologies for electric vehicle batteries",
      "digest_text": "Electric vehicle battery technology"
    }
  ],
  "title": "Electric Vehicle Landscape Analysis",
  "job_id": "landscape_job_12345",
  "stemming": true,
  "time_stop": "2020-12-31",
  "time_type": "filing_date",
  "par_job_id": "job123",
  "time_start": "2010-01-01",
  "browser_uri": "https://example.com/search?q=electric+vehicle",
  "description": "Analysis of electric vehicle technologies",
  "time_slices": "year",
  "dashboard_id": "dashboard123",
  "filter_query": "assignee:(Tesla)",
  "request_type": "som",
  "expired_collapse": true,
  "exclude_expired_patent": false
}

响应结构

API 响应数据的结构说明

字段名	类型	示例	描述
`data`	`string`	`123`	响应数据
`status`	`boolean`	`true`	响应状态

成功响应示例

成功调用 API 的响应示例

JSON

{
  "data": 123,
  "status": true,
  "error_code": 0
}

错误码

此接口可能返回的错误码列表

业务错误码

错误码	描述
`68300004`	请求参数异常!
`68300005`	查询Api失败!
`68300006`	解析基本存取错误!
`68300007`	存在错误的请求!
`68300008`	服务中断异常，请稍后再试!
`68300010`	文件不符合上传规范!

平台错误码

错误码	描述
`67200000`	API整体限流错误!
`67200001`	API整体限流错误！
`67200002`	当前调用速率过快,超过当前配置限制QPS！
`67200003`	申请token的key和secret传参不正确或者客户端已被禁用！
`67200004`	请求的接口无权限请联系我们的支持人员！
`67200005`	账户余额/调用次数不足！
`67200006`	客户端超过开通有效期！
`67200007`	当前调用超过当天配置使用额度！
`67200008`	请检查query参数中必填的apikey是否传输！
`67200009`	apikey与所传的bearerToken不匹配,请检查是否使用在有效期内的token！
`67200012`	请求不合法！
`67200100`	当前服务器状态正忙,请求响应超时！
`67200101`	当前请求的Api不存在请检查请求Path！

HTTP 状态码

状态码	描述
`0`	请求成功
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

性能指标

此接口的预期性能特征

正常响应时间

5000 ms

最大响应时间

10000 ms