API_Proposal_Q&A_Assistant_Service_ChinaMobile.md

October 14, 2024 ยท View on GitHub

FieldDescription
API family nameQ&A Assistant - Service (from "MaaS" API family)
API family ownerChina Mobile, ZTE, Huawei
API family summaryThis API is based on the already built Q&A Assistant application, providing Q&A services to the users of the application. Users input prompts with questions they want to know, and the Q&A application returns answers based on the large model and knowledge base.

Input params
assistant id
prompt

Output params
success or failure response
finished(Stop / Length / Error / Filter)
answer text
reference (optional)
Technical viabilityBased on the established Q&A Assistant, this API supports the Q&A Assistant in providing Q&A services to application users.
Commercial viabilityThis API provide services to the users of the Q&A Assistant.
YAML code available?N/A
Validated in lab/productive environments?
YES
This API have been validated in JiuTian Model Hub (productive environments).
Validated with real customers?
YES
On the JiuTian Model Hub, more than 50 Q&A Assistant have been built based on the MaaS offering to serve customers.
Validated with operators?
YES
China Mobile has conducted practical verification on the Jiutian Model Hub.
Supporters in API Backlog Working Group