AI Miaosou – Intelligent Search Generation: This API delivers the search and generation capabilities of the Miaosou homepage. It supports general search and media asset search, along with features such as user query clarification, multimodal knowledge search, and multi-agent generation. – General Search: Performs semantic retrieval on centralized knowledge data and applies multi-agent post-processing to the results, such as summary generation, abstracting, and timeline summarization. – Media Asset Search: Conducts an exhaustive full-text search to retrieve highly relevant knowledge and supports multi-agent post-processing, such as clustering and news extraction.

Operation description

Integration notes:

• This API uses the HTTP Server-Sent Events (SSE) protocol.
• The OpenAPI console does not support SSE inference protocols and cannot be used for direct testing. For SDK-based integration examples (Java and Python), see the Miaosou Best Practices documentation.
• To obtain the latest version of the Java asynchronous SDK, click this link.

Data sources for search:

Supports three dataset types. See the Miaosou Best Practices documentation for details.

• Built-in “Internet search” dataset: Supports open-domain text, images, and video (video is not yet available) from the Internet.
• Semantic (RAG) dataset: Manages enterprise private knowledge bases and supports text, images, video, and voice (voice is not yet available).
• Third-party API dataset: Integrates directly with your own enterprise search APIs.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

• Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

• API: The API that you can call to perform the action.

• Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

• Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

  • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
  • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

• Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

• Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Request syntax

POST /quanmiao/aimiaosou/runSearchGeneration HTTP/1.1

Request parameters

# Role
You are an expert article retrieval and Q&A assistant.

# Goal
Answer or explain the user's question "{query}" using the retrieved articles.

# Constraints
- Filter by knowledge date if the question mentions a specific date.
- Structure responses clearly.
- Keep responses concise.
- Do not use external data or fabricate answers.
- If unable to answer, respond in the appropriate language:
  - Chinese: "Unable to answer based on known information."
  - English: "Unable to answer based on the known information."

# Input
## Retrieved articles
{content}

# Role
You are an expert article retrieval and Q&A assistant.

# Goal
Answer or explain the user's question "{query}" using the retrieved articles and images.

# Constraints
- Filter by knowledge date if the question mentions a specific date.
- Structure responses clearly.
- Keep responses concise.
- Ignore article content if image content fully answers the question.
- Do not use external data or fabricate answers.
- If unable to answer, respond in the appropriate language:
    - Chinese: "Unable to answer based on known information."
    - English: "Unable to answer based on the known information."

# Input
## Retrieved articles
{content}

Response elements

Examples

Success response

JSON format

{
  "Payload": {
    "Output": {
      "AgentContext": {
        "BizContext": {
          "CurrentStep": "start",
          "NextStep": "search",
          "GeneratedContent": {
            "ClusterTopicResult": {
              "ClusterTopics": [
                {
                  "Topic": "xx",
                  "ImageSearchResult": {
                    "SearchResult": [
                      {
                        "Article": {
                          "SearchSourceName": "互联网搜索",
                          "Title": "xx",
                          "Url": "xx",
                          "Summary": "xx",
                          "DocUuid": "xx",
                          "DocId": "xx",
                          "CategoryUuid": "xx",
                          "Tags": [
                            "xx"
                          ],
                          "Extend1": "xx",
                          "Extend2": "xx",
                          "Extend3": "xx",
                          "SearchSourceType": "xx",
                          "SearchSource": "xx"
                        },
                        "MediaId": "xx",
                        "FileUrl": "xx"
                      }
                    ],
                    "Current": 1,
                    "Size": 1,
                    "Total": 1
                  },
                  "TextSearchResult": {
                    "SearchResult": [
                      {
                        "SearchSourceType": "SystemSearch",
                        "SearchSource": "QuarkCommonNews",
                        "SearchSourceName": "互联网搜索",
                        "PubTime": "2023-04-04 08:39:09",
                        "Title": "xx",
                        "Url": "xx",
                        "Summary": "xx",
                        "DocUuid": "xx",
                        "DocId": "xx",
                        "MultimodalMedias": [
                          {
                            "MediaId": "xx",
                            "MediaType": "image",
                            "FileUrl": "xx"
                          }
                        ],
                        "CategoryUuid": "xx",
                        "Tags": [
                          "xx"
                        ],
                        "Extend1": "xx",
                        "Extend2": "xx",
                        "Extend3": "xx"
                      }
                    ],
                    "Current": 1,
                    "Size": 1,
                    "Total": 1
                  },
                  "VideoSearchResult": {
                    "SearchResult": [
                      {
                        "Article": {
                          "SearchSourceName": "互联网搜索",
                          "Title": "xx",
                          "Url": "xx",
                          "Summary": "xx",
                          "DocUuid": "xx",
                          "DocId": "xx",
                          "CategoryUuid": "xx",
                          "Tags": [
                            "xx"
                          ],
                          "Extend1": "xx",
                          "Extend2": "xx",
                          "Extend3": "x",
                          "SearchSourceType": "xx",
                          "SearchSource": "xx"
                        },
                        "MediaId": "xx",
                        "ClipInfos": [
                          {
                            "Score": 0.9,
                            "From": 1,
                            "To": 1,
                            "Text": "xx",
                            "Type": "asr"
                          }
                        ],
                        "FileUrl": "xx"
                      }
                    ],
                    "Current": 1,
                    "Size": 1,
                    "Total": 1
                  },
                  "AudioSearchResult": {
                    "SearchResult": {
                      "FileUrl": "http://xx",
                      "MediaId": "xxx",
                      "ClipInfos": [
                        {
                          "Score": 1,
                          "From": 1,
                          "To": 1,
                          "Text": "xx",
                          "Type": "asr"
                        }
                      ],
                      "Article": {
                        "Title": "xx",
                        "Url": "http://xx",
                        "Summary": "xx",
                        "DocUuid": "xx",
                        "DocId": "xx",
                        "SearchSourceName": "xx",
                        "CategoryUuid": "xx",
                        "Tags": [
                          "xx"
                        ],
                        "Extend1": "xx",
                        "Extend2": "xx",
                        "Extend3": "xx",
                        "SearchSourceType": "xx",
                        "SearchSource": "xx"
                      }
                    },
                    "Current": 1,
                    "Size": 1,
                    "Total": 1
                  }
                }
              ],
              "TextGenerate": "xx",
              "GenerateFinished": true
            },
            "ExcerptResult": {
              "TextGenerate": "xx",
              "SearchResult": [
                {
                  "TraceabilityId": 1,
                  "SearchSourceType": "SystemSearch",
                  "SearchSource": "QuarkCommonNews",
                  "SearchSourceName": "互联网搜索",
                  "PubTime": "2023-04-04 08:39:09",
                  "Title": "xx",
                  "Content": "xx",
                  "Url": "xx",
                  "Summary": "xx",
                  "Excerpt": "xx",
                  "Select": true,
                  "DocUuid": "xx",
                  "Score": 0.99,
                  "Chunks": [
                    "xx"
                  ],
                  "DocId": "xx",
                  "TextGenerateMultimodalMediaList": [
                    {
                      "Start": 1,
                      "End": 1,
                      "DocUuid": "xx",
                      "MultimodalMediaList": [
                        {
                          "Article": {
                            "DocId": "xx",
                            "DocUuid": "xx",
                            "SearchSourceName": "互联网搜索",
                            "Title": "xx",
                            "Url": "xx"
                          },
                          "MediaId": "xx",
                          "MediaType": "image",
                          "FileUrl": "xx"
                        }
                      ]
                    }
                  ],
                  "MultimodalMedias": [
                    {
                      "MediaId": "xx",
                      "MediaType": "image",
                      "FileUrl": "xx"
                    }
                  ],
                  "CategoryUuid": "xx",
                  "Extend1": "xx",
                  "Extend2": "xx",
                  "Extend3": "xx",
                  "Tags": [
                    "xx"
                  ]
                }
              ],
              "GenerateFinished": true,
              "GenerateLevel": "concise",
              "ReasonTextGenerate": "xx"
            },
            "NewsElementResult": {
              "TextGenerate": "x",
              "NewsElementArticleList": [
                {
                  "TextGenerate": "xx",
                  "Article": {
                    "SearchSourceType": "SystemSearch",
                    "SearchSource": "QuarkCommonNews",
                    "SearchSourceName": "互联网搜索",
                    "PubTime": "2023-04-04 08:39:09",
                    "Title": "xx",
                    "Content": "xx",
                    "Url": "xx",
                    "Summary": "xx",
                    "Select": true,
                    "DocUuid": "xx",
                    "Score": 0.99,
                    "DocId": "xx",
                    "CategoryUuid": "xx",
                    "Tags": [
                      "xx"
                    ],
                    "Extend1": "xx",
                    "Extend2": "xx",
                    "Extend3": "xx"
                  },
                  "NewsElementList": [
                    {
                      "Time": "时间",
                      "Location": "xx",
                      "People": "xx",
                      "Event": {
                        "CauseList": [
                          "xx"
                        ],
                        "ProcessList": [
                          "xx"
                        ],
                        "ResultList": [
                          "xx"
                        ]
                      }
                    }
                  ]
                }
              ],
              "GenerateFinished": true
            },
            "TextGenerateResult": {
              "TextGenerate": "xx",
              "TextGenerateMultimodalMediaList": [
                {
                  "Start": 1,
                  "End": 1,
                  "MultimodalMediaList": [
                    {
                      "Article": {
                        "SearchSourceName": "xx",
                        "Title": "xx",
                        "Url": "xx",
                        "Summary": "xx",
                        "DocUuid": "xx",
                        "DocId": "xx"
                      },
                      "MediaId": "xx",
                      "MediaType": "image",
                      "FileUrl": "xx"
                    }
                  ]
                }
              ],
              "ReferenceList": [
                {
                  "TraceabilityId": 1,
                  "SearchSourceType": "SystemSearch",
                  "SearchSource": "QuarkCommonNews",
                  "SearchSourceName": "互联网搜索",
                  "PubTime": "2023-04-04 08:39:09",
                  "Source": "新华社",
                  "Title": "xx",
                  "Content": "xx",
                  "Url": "xx",
                  "Summary": "xx",
                  "Select": true,
                  "DocUuid": "xx",
                  "Score": 0.99,
                  "Chunks": [
                    "xx"
                  ],
                  "DocId": "xx",
                  "CategoryUuid": "xx",
                  "Tags": [
                    "xx"
                  ],
                  "Extend1": "xx",
                  "Extend2": "xx",
                  "Extend3": "xx"
                }
              ],
              "MultimodalSearchResultList": [
                {
                  "SearchResult": [
                    {
                      "Article": {
                        "SearchSourceName": "xx",
                        "Title": "xx",
                        "Url": "xx",
                        "Summary": "xx",
                        "DocUuid": "xx",
                        "DocId": "xx"
                      },
                      "MediaId": "xx",
                      "MediaType": "image",
                      "ClipInfos": [
                        {
                          "Score": 0.1,
                          "From": 1,
                          "To": 1,
                          "Text": "xx",
                          "Type": "asr"
                        }
                      ],
                      "FileUrl": "xx"
                    }
                  ],
                  "TimelineDateStr": "时间脉络-时间",
                  "Current": 1,
                  "Size": 1,
                  "Total": 1,
                  "SearchType": "realtime",
                  "SearchQuery": "xx"
                }
              ],
              "GenerateTraceability": {
                "Duplicate": 0.9,
                "Coordinates": [
                  {
                    "GenerateCoordinate": {
                      "X": 1,
                      "Y": 1,
                      "Z": 1
                    },
                    "NewsCoordinate": {
                      "X": 1,
                      "Y": 1,
                      "Z": 1,
                      "MediaType": "image"
                    }
                  }
                ]
              },
              "GenerateFinished": true,
              "GenerateLevel": "concise",
              "ReasonTextGenerate": "xx"
            },
            "TimelineResult": {
              "TextGenerate": "xx",
              "ReferenceList": [
                {
                  "TraceabilityId": 1,
                  "SearchSourceType": "SystemSearch",
                  "SearchSource": "QuarkCommonNews",
                  "SearchSourceName": "互联网搜索",
                  "PubTime": "2023-04-04 08:39:09",
                  "Source": "新华社",
                  "Title": "xx",
                  "Content": "xx",
                  "Url": "xx",
                  "Summary": "xx",
                  "Select": true,
                  "DocUuid": "xx",
                  "Score": 0.99,
                  "Chunks": [
                    "xx"
                  ],
                  "DocId": "xx",
                  "CategoryUuid": "xx",
                  "Tags": [
                    "xx"
                  ],
                  "Extend1": "xx",
                  "Extend2": "xx",
                  "Extend3": "xx"
                }
              ],
              "MultimodalSearchResultList": [
                {
                  "SearchResult": [
                    {
                      "Article": {
                        "SearchSourceName": "互联网搜索",
                        "Title": "xx",
                        "Url": "xx",
                        "Summary": "xx",
                        "DocUuid": "xx",
                        "DocId": "xx"
                      },
                      "MediaId": "xx",
                      "MediaType": "image",
                      "ClipInfos": [
                        {
                          "Score": 0.99,
                          "From": 1,
                          "To": 1,
                          "Text": "xx",
                          "Type": "asr"
                        }
                      ],
                      "FileUrl": "xx"
                    }
                  ],
                  "TimelineDateStr": "2024-09-11"
                }
              ],
              "GenerateTraceability": {
                "Duplicate": 0.9,
                "Coordinates": [
                  {
                    "GenerateCoordinate": {
                      "X": 1,
                      "Y": 1,
                      "Z": 1
                    },
                    "NewsCoordinate": {
                      "X": 1,
                      "Y": 1,
                      "Z": 1,
                      "MediaType": "image"
                    }
                  }
                ]
              },
              "TextGenerateMultimodalMediaList": [
                {
                  "Start": 1,
                  "End": 1,
                  "MultimodalMediaList": [
                    {
                      "Article": {
                        "SearchSourceName": "互联网搜索",
                        "Title": "xxxx",
                        "Url": "xx",
                        "Summary": "xx",
                        "DocUuid": "xx",
                        "DocId": "xx"
                      },
                      "MediaId": "xx",
                      "MediaType": "image",
                      "FileUrl": "xx"
                    }
                  ]
                }
              ],
              "GenerateFinished": true,
              "ReasonTextGenerate": "xx"
            },
            "VideoSearchResult": {
              "SearchResult": [
                {
                  "Article": {
                    "SearchSourceName": "互联网搜索",
                    "Title": "xx",
                    "Url": "xx",
                    "Summary": "xx",
                    "DocUuid": "xx",
                    "DocId": "xx",
                    "CategoryUuid": "xx",
                    "Tags": [
                      "xx"
                    ],
                    "Extend1": "xx",
                    "Extend2": "xx",
                    "Extend3": "xx"
                  },
                  "MediaId": "xx",
                  "ClipInfos": [
                    {
                      "Score": 0.8,
                      "From": 1,
                      "To": 1,
                      "Text": "xx",
                      "Type": "asr"
                    }
                  ],
                  "FileUrl": "xx",
                  "TraceabilityId": "1"
                }
              ]
            },
            "ImageSearchResult": {
              "SearchResult": [
                {
                  "Article": {
                    "SearchSourceName": "互联网搜索",
                    "Title": "xx",
                    "Url": "xx",
                    "Summary": "xx",
                    "DocUuid": "xx",
                    "DocId": "xx",
                    "CategoryUuid": "xx",
                    "Tags": [
                      "xx"
                    ],
                    "Extend1": "xx",
                    "Extend2": "xx",
                    "Extend3": "xx"
                  },
                  "MediaId": "xx",
                  "FileUrl": "xx",
                  "TraceabilityId": "1"
                }
              ]
            },
            "TextSearchResult": {
              "Current": 1,
              "Size": 1,
              "Total": 1,
              "SearchResult": [
                {
                  "DocId": "xx",
                  "DocUuid": "xx",
                  "SearchSourceType": "SystemSearch",
                  "SearchSource": "QuarkCommonNews",
                  "SearchSourceName": "xxx",
                  "PubTime": "2024-11-25 14:25:59",
                  "Content": "xx",
                  "Url": "xx",
                  "Title": "xx",
                  "Summary": "xx",
                  "TraceabilityId": "1",
                  "CategoryUuid": "xx",
                  "Tags": [
                    "xx"
                  ],
                  "Extend1": "xx",
                  "Extend2": "xx",
                  "Extend3": "xx"
                }
              ]
            },
            "AudioSearchResult": {
              "SearchResult": [
                {
                  "MediaId": "xxx",
                  "FileUrl": "http://xxx",
                  "Article": {
                    "Title": "xx",
                    "Url": "http://xxx",
                    "Summary": "xxx",
                    "DocUuid": "xx",
                    "DocId": "xx",
                    "SearchSourceName": "xx",
                    "Extend1": "xx",
                    "Extend2": "xx",
                    "Extend3": "xx",
                    "Tags": [
                      "x"
                    ],
                    "CategoryUuid": "xx"
                  },
                  "ClipInfos": [
                    {
                      "Score": 0.9,
                      "From": 1,
                      "To": 2,
                      "Text": "xx",
                      "Type": "asr"
                    }
                  ],
                  "TraceabilityId": "1"
                }
              ]
            }
          },
          "SearchKeywords": [
            "xx"
          ],
          "SearchQueryList": [
            "xx"
          ],
          "RecommendSearchQueryList": [
            "xx"
          ],
          "SupplementDataType": "searchQuery",
          "SupplementEnable": true,
          "ModelId": "xx",
          "TokenCalculate": {
            "FirstTokenTime": 1,
            "SearchTime": 1,
            "OutputAvgTime": 1,
            "Time": 1,
            "TotalTokens": 1
          },
          "AskUser": "您想了解关于xx的哪些信息？",
          "AskUserKeywords": [
            "时间"
          ]
        }
      },
      "Messages": [
        {
          "Id": "xx",
          "Content": "xx",
          "GenerateFinished": false,
          "Clarifications": false,
          "SearchQueries": [
            "xx"
          ],
          "SearchResult": [
            {
              "MultimodalSearchQuery": "xx",
              "Texts": [
                {
                  "DocUuid": "xx"
                }
              ],
              "Images": [
                {
                  "MediaId": "xx"
                }
              ],
              "Audios": [
                {
                  "MediaId": "xx"
                }
              ],
              "Videos": [
                {
                  "MediaId": "1"
                }
              ]
            }
          ],
          "NodeCode": "generateStartStatement",
          "SearchQuery": "xx"
        }
      ]
    },
    "Usage": {
      "OutputTokens": 2,
      "InputTokens": 1,
      "TotalTokens": 3
    }
  },
  "Header": {
    "SessionId": "x",
    "TraceId": "xx",
    "TaskId": "x",
    "OriginSessionId": "3f7045e099474ba28ceca1b4eb6d6e21",
    "Event": "task-failed",
    "ErrorCode": "AccessForbid",
    "ErrorMessage": "xx",
    "EventInfo": "xx",
    "ResponseTime": 1
  },
  "RequestId": "xx"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.