This document provides the OpenAPI JSON Schema for the Search API.
OpenAPI definition
openapi: 3.1.0 info: version: 1.1.0 title: IQS description: "IQS is a powerful, real-time search API that provides structured data from multiple search engines and knowledge bases." servers: - url: https://cloud-iqs.aliyuncs.com/search security: - bearer: [] paths: /llm: post: operationId: search summary: Search description: "Retrieves clean, accurate, diverse, and high-quality results from the open web. This endpoint leverages large language model (LLM) optimizations and data fusion from multiple sources to enhance its search capabilities." x-codeSamples: - lang: bash label: Simple search and contents source: | curl -X POST 'https://cloud-iqs.aliyuncs.com/search/llm' \ -H 'Authorization: Bearer IQS-API-KEY' \ -H 'Content-Type: application/json' \ -d '{ "query": "Alibaba" }' requestBody: required: true content: application/json: schema: type: object properties: query: type: string description: "The search query. Must be 2 to 100 characters long." numResults: type: integer maximum: 10 default: 5 description: "The number of search results to return." example: 5 required: - query responses: "200": $ref: "#/components/responses/SearchResponse" components: securitySchemes: apikey: type: apiKey name: X-API-Key in: header description: Provide the API key using the X-API-Key header. bearer: type: http scheme: bearer description: Provide the API key in the Authorization header using the Bearer scheme. schemas: PageItem: type: object properties: title: type: string description: "The title of the web page." link: type: string format: uri description: "The URL of the web page." publishedDate: type: string nullable: true description: "The publication time of the web page, in ISO 8601 format." hostname: type: string description: "The hostname of the website." summary: type: string nullable: true description: "A summary of the web page." mainText: type: string nullable: true description: "The full text extracted from the web page. The maximum length is 3000 characters." responses: SearchResponse: description: OK content: application/json: schema: type: object properties: requestId: type: string description: Unique identifier for the request example: "35E5608A-A737-2038-****-D9D34C6BFD9E" pageItems: type: array description: "A list of web search results." items: $ref: "#/components/schemas/PageItem" sceneItems: type: array description: "A list of search results for vertical scenarios." items: type: object properties: type: type: string enum: [weather, time, rili] description: "The type of the vertical scenario." detail: type: string description: "Details for the vertical scenario result."OpenAPI Schema
openapi: 3.1.0 info: version: 1.1.0 title: IQS description: "IQS is a powerful, real-time search API that provides structured data from multiple search engines and knowledge bases." servers: - url: https://cloud-iqs.aliyuncs.com/search security: - bearer: [] paths: /llm: post: operationId: search summary: Search description: "Retrieves clean, accurate, diverse, and high-quality results from the open web. This endpoint leverages large language model (LLM) optimizations and data fusion from multiple sources to enhance its search capabilities." x-codeSamples: - lang: bash label: Simple search and contents source: | curl -X POST 'https://cloud-iqs.aliyuncs.com/search/llm' \ -H 'Authorization: Bearer IQS-API-KEY' \ -H 'Content-Type: application/json' \ -d '{ "query": "Alibaba" }' requestBody: required: true content: application/json: schema: type: object properties: query: type: string description: "The search query. Must be 2 to 100 characters long." numResults: type: integer maximum: 10 default: 5 description: "The number of search results to return." example: 5 required: - query responses: "200": $ref: "#/components/responses/SearchResponse" components: securitySchemes: apikey: type: apiKey name: X-API-Key in: header description: Provide the API key using the X-API-Key header. bearer: type: http scheme: bearer description: Provide the API key in the Authorization header using the Bearer scheme. schemas: PageItem: type: object properties: title: type: string description: "The title of the web page." link: type: string format: uri description: "The URL of the web page." publishedDate: type: string nullable: true description: "The publication time of the web page, in ISO 8601 format." hostname: type: string description: "The hostname of the website." summary: type: string nullable: true description: "A summary of the web page." mainText: type: string nullable: true description: "The full text extracted from the web page. The maximum length is 3000 characters." responses: SearchResponse: description: OK content: application/json: schema: type: object properties: requestId: type: string description: Unique identifier for the request example: "35E5608A-A737-2038-****-D9D34C6BFD9E" pageItems: type: array description: "A list of web search results." items: $ref: "#/components/schemas/PageItem" sceneItems: type: array description: "A list of search results for vertical scenarios." items: type: object properties: type: type: string enum: [weather, time, rili] description: "The type of the vertical scenario." detail: type: string description: "Details for the vertical scenario result."
该文章对您有帮助吗？