Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New API Family porposal - MaaS (Model as a Service) #84

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
| **Field** | Description |
| ---- | ----- |
| API family name | MaaS (Model as a Service) |
| API family owner| China Mobile |
| API family summary | **Background:**<br>MaaS (Model as a Services) refers to the packaging of AI models and their associated capabilities into reusable services, enabling users to quickly and efficiently build, deploy, monitor, and invoke models without the need to develop and maintain underlying foundational capabilities.<br><br>**Scenario**<br>**Intelligent Customer Service for Multinational Enterprises:** A Chinese-based multinational apparel company plans to introduce large model technology to optimize its online customer service system that directly faces end customers. Local CSPs (Communication Service Providers) can provide standardized large model services that comply with local data regulations and cultural traditions. These CSPs have connection points closer to users and possess extensive knowledge and experience in local culture, security, and data governance. Through standardized APIs, these capabilities can be directly utilized by multinational enterprises or application developers for rapid reuse.<br><br>**Input params**<br>N/A<br><br>**Output params**<br>N/A<br><br>**Notifications** <br> N/A <br> |
| Technical viability | Based on the large model capabilities provided by the model provider integrated with the CSPs, it supports the construction of large model applications according to the needs of the developers. |
| Commercial viability | MaaS offers convenient large model services for users who need simple and quick access to big models.|
| YAML code available? | N/A <br>|
| Validated in lab/productive environments? | <br>YES<br> MaaS-related APIs have been validated in JiuTian Model Hub (productive environments)<br> |
| Validated with real customers? | <br>YES<br>On the JiuTian Model Hub, more than 50 applications have been built based on the MaaS offering. <br>|
| Validated with operators? | <br>YES<br>China Mobile has already employed a multitude of services based on the MaaS. <br> |
| Supporters in API Backlog Working Group | |
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
| **Field** | Description |
| ---- | ----- |
| API family name | Knowledge Base - Manage (from "MaaS" API family) |
| API family owner| China Mobile |
| API family summary | The API supports users in building and managing knowledge bases, including the creation, updating, querying, modification, and publication of the knowledge base.<br><br>**Scenario:**<br>Referring to the application scenarios of MaaS, the API supports enterprises in uploading product knowledge to build product and customer service knowledge bases for Q&A assistants to query and invoke.<br><br>**Input params**<br>name<br>description<br>document(doc/pdf/txt/csv)<br><br>**Output params**<br>success or failure response<br>knowledge base id<br>
| Technical viability | This API constructs the knowledge base based on the knowledge provided by users (including doc/pdf/txt/csv), which can be utilized by Q&A assistants. |
| Commercial viability | This API provides services for users who need to build a knowledge base.|
| YAML code available? | N/A <br>|
| Validated in lab/productive environments? | <br>YES<br> This API have been validated in JiuTian Model Hub (productive environments).<br> |
| Validated with real customers? | <br>YES<br>On the JiuTian Model Hub, more than 50 Knowledge Base have been built. <br>|
| Validated with operators? | <br>YES<br>China Mobile has conducted practical verification on the Jiutian Model Hub. <br> |
| Supporters in API Backlog Working Group | |
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
| **Field** | Description |
| ---- | ----- |
| API family name | Q&A Assistant - Manage (from "MaaS" API family) |
| API family owner| China Mobile |
| API family summary | This API enables developers to quickly construct unique Q&A Assistant applications based on various models and datasets provided by MaaS according to customer needs.<br>The Q&A Assistant application fully leverages the intent understanding capabilities of LLMs. It combines a proprietary dataset to answer users' questions in natural language.<br><br>**Input params**<br>name<br>description<br>knowledge base id (optional)<br>configuration prompt<br>opening remarks (optional)<br><br>**Output params**<br>success or failure response<br>knowledge base id<br>
| Technical viability | Based on the large model capabilities provided by the model provider integrated with the CSPs, it supports the construction of Q&A Assistant according to the needs of the developers. |
| Commercial viability | This API offers services to developers who need to construct Q&A Assistants.|
| YAML code available? | N/A <br>|
| Validated in lab/productive environments? | <br>YES<br> This API have been validated in JiuTian Model Hub (productive environments).<br> |
| Validated with real customers? | <br>YES<br>On the JiuTian Model Hub, more than 50 Q&A Assistant have been built based on the MaaS offering. <br>|
| Validated with operators? | <br>YES<br>China Mobile has conducted practical verification on the Jiutian Model Hub. <br> |
| Supporters in API Backlog Working Group | |
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
| **Field** | Description |
| ---- | ----- |
| API family name | Q&A Assistant - Service (from "MaaS" API family) |
| API family owner| China Mobile |
| API family summary | This 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.<br><br>**Input params**<br>assistant id<br>prompt<br><br>**Output params**<br>success or failure response<br>finished(Stop / Length / Error / Filter)<br>answer text<br>reference (optional)<br>
| Technical viability | Based on the established Q&A Assistant, this API supports the Q&A Assistant in providing Q&A services to application users. |
| Commercial viability | This API provide services to the users of the Q&A Assistant.|
| YAML code available? | N/A <br>|
| Validated in lab/productive environments? | <br>YES<br> This API have been validated in JiuTian Model Hub (productive environments).<br> |
| Validated with real customers? | <br>YES<br>On the JiuTian Model Hub, more than 50 Q&A Assistant have been built based on the MaaS offering to serve customers. <br>|
| Validated with operators? | <br>YES<br>China Mobile has conducted practical verification on the Jiutian Model Hub. <br> |
| Supporters in API Backlog Working Group | |