OpenAPI Specification
更新时间：
为以下接口提供 OpenAPI JSON Schema：标准搜索API - GenericSearch
OpenAPI 定义
{
"openapi": "3.1.0",
"info": {
"title": "通晓",
"description": "'通晓' 是一个强大的实时搜索 API，可提供来自多种搜索引擎、知识库集合的结构化数据。",
"version": "v1.0.0"
},
"servers": [
{
"url": "https://cloud-iqs.aliyuncs.com/search"
}
],
"paths": {
"/genericSearch": {
"get": {
"operationId": "GetGenericSearch",
"summary": "Generic Search",
"description": "标准搜索，可以提供开放域的实时搜索能力",
"x-codeSamples": {
"lang": "bash",
"label": "Bash 脚本搜索并获取相关内容",
"source": "curl -H 'X-API-Key: <TONGXIAO-API-KEY>' -X GET 'https://cloud-iqs.aliyuncs.com/search/genericSearch?query=<Query>'"
},
"parameters": [
{
"name": "query",
"in": "query",
"description": "搜索问题（长度：>=2 and <=100）",
"required": true,
"schema": {
"type": "string"
}
}
]
}
}
},
"components": {
"schemas": {
"pageItem": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "网站标题",
"example": "2024五一劳动节放假调休时间表（附放假日历）"
},
"snippet": {
"type": "string",
"description": "网页动态摘要，查询关键字命中的部分内容",
"example": "2024五一劳动节放假安排：5月1日至5日放假调休，共5天。4月28日（星期日）、5月11日（星期六）上班。"
},
"mainText": {
"type": "string",
"description": "网页正文",
"example": "导语\t\t \t\t2024\t五一\t劳动\t节\t放假\t安排\t：\t5\t月\t1\t日\t至\t5\t日\t放假\t调休\t，\t共\t5\t天\t。\t4\t月\t28\t日\t（\t星期\t日\t）\t、\t5\t月\t11\t日\t（\t星期\t六\t）\t上班\t。\t\t\n\t\t2024\t五一\t劳动\t节\t放假\t安排\t\t\n\t\t5\t月\t1\t日\t至\t5\t日\t放假\t调休\t，\t共\t5\t天\t。\t4\t月\t28\t日\t(\t星期\t日\t)\t、\t5\t月\t11\t日\t(\t星期\t六\t)\t上班\t。\t\t\n\t\t第\t一\t天"
},
"hostname": {
"type": "string",
"description": "站点名",
"example": "新华网"
},
"link": {
"type": "string",
"description": "网站地址",
"example": "http://m.sh.bendibao.com/tour/278811.html"
},
"publishTime": {
"type": "integer",
"description": "发布时间，时间戳单位（毫秒），对于部分没有发布时间的网站会使用默认值：0",
"example": 1714123620000
},
"score": {
"type": "number",
"format": "float",
"description": "相关度分数",
"example": []
}
}
}
},
"responses": {
"SearchResponse": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"description": "请求的唯一ID",
"example": "b5947044c4b78efa9552a7c89b306d95"
},
"pageItems": {
"type": "array",
"description": "搜索结果，包括标题、内容、链接、发布时间和评分。",
"items": {
"$ref": "#/components/schemas/pageItem"
}
}
}
}
}
}
}
}
}
}OpenAPI Schema
{
"openapi": "3.1.0",
"info": {
"title": "Tongxiao",
"description": "Tongxiao is a powerful real-time search API that provides structured data from various search engines and knowledge base collections.",
"version": "v1.0.0"
},
"servers": [
{
"url": "https://cloud-iqs.aliyuncs.com/search"
}
],
"paths": {
"/genericSearch": {
"get": {
"operationId": "GetGenericSearch",
"summary": "Generic Search",
"description": "General search can provide open-domain real-time search capabilities.",
"x-codeSamples": {
"lang": "bash",
"label": "Simple search and contents",
"source": "curl -H 'X-API-Key: <TONGXIAO-API-KEY>' -X GET 'https://cloud-iqs.aliyuncs.com/search/genericSearch?query=<Query>'"
},
"parameters": [
{
"name": "query",
"in": "query",
"description": "Search question (length: >= 2 and <= 100)",
"required": true,
"schema": {
"type": "string"
}
}
]
}
}
},
"components": {
"schemas": {
"pageItem": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Website Title",
"example": "2024五一劳动节放假调休时间表（附放假日历）"
},
"snippet": {
"type": "string",
"description": "Dynamic summary of the webpage, the content that matches the queried keywords.",
"example": "2024五一劳动节放假安排：5月1日至5日放假调休，共5天。4月28日（星期日）、5月11日（星期六）上班。"
},
"mainText": {
"type": "string",
"description": "Webpage Content",
"example": "导语\t\t \t\t2024\t五一\t劳动\t节\t放假\t安排\t：\t5\t月\t1\t日\t至\t5\t日\t放假\t调休\t，\t共\t5\t天\t。\t4\t月\t28\t日\t（\t星期\t日\t）\t、\t5\t月\t11\t日\t（\t星期\t六\t）\t上班\t。\t\t\n\t\t2024\t五一\t劳动\t节\t放假\t安排\t\t\n\t\t5\t月\t1\t日\t至\t5\t日\t放假\t调休\t，\t共\t5\t天\t。\t4\t月\t28\t日\t(\t星期\t日\t)\t、\t5\t月\t11\t日\t(\t星期\t六\t)\t上班\t。\t\t\n\t\t第\t一\t天"
},
"hostname": {
"type": "string",
"description": "Website Name",
"example": "新华网"
},
"link": {
"type": "string",
"description": "Website URL",
"example": "http://m.sh.bendibao.com/tour/278811.html"
},
"publishTime": {
"type": "integer",
"description": "Publish time, timestamp unit (milliseconds). For some websites without a publish time, the default value of 0 will be used.",
"example": 1714123620000
},
"score": {
"type": "number",
"format": "float",
"description": "Relevance Score",
"example": []
}
}
}
},
"responses": {
"SearchResponse": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"requestId": {
"type": "string",
"description": "Unique identifier for the request",
"example": "a234zz4ac4b78efa9552a7b39a305gz2"
},
"pageItems": {
"type": "array",
"description": "A list of search results containing title, content, link, published time, and score.",
"items": {
"$ref": "#/components/schemas/pageItem"
}
}
}
}
}
}
}
}
}
}该文章对您有帮助吗？