Public Release r1.2 for ModelAsAService APIs (Fall25 M4) by lihaojie-CMCC · Pull Request #18 · camaraproject/ModelAsAService

lihaojie-CMCC · 2025-08-26T16:04:30Z

What type of PR is this?

Add one of the following kinds:

subproject management

What this PR does / why we need it:

Create the initial public release of Model As A Service APIs to be included in Fall25 Meta release.

Which issue(s) this PR fixes:

Fixes #

github-actions · 2025-08-26T16:05:40Z

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Errors	Elapsed time
✅ ACTION	actionlint	2	0	0.01s
✅ API	spectral	3	0	4.04s
✅ GHERKIN	gherkin-lint	3	0	1.04s
✅ REPOSITORY	git_diff	yes	no	0.0s
✅ REPOSITORY	secretlint	yes	no	0.66s
✅ YAML	yamllint	3	0	0.59s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by

lihaojie-CMCC · 2025-08-26T16:09:02Z

Work in Progress

hdamker · 2025-08-27T06:41:31Z

@lihaojie-CMCC Please merge the main branch into the PR branch and resolve the merge conflicts. If done mark it again as "Ready for review".

…-base-API-Readiness-Checklist.md

…ssistant-manage-API-Readiness-Checklist.md

…assistant-service-API-Readiness-Checklist.md

lihaojie-CMCC · 2025-08-28T12:40:48Z

This PR is ready for review.

tanjadegroot

Overall looks good !
a few fixes and comments, some of which can be delayed till next release (up to the team).

Side comment, generally in the API yamls some more description fields would be good.

CHANGELOG.md

README.md

code/API_definitions/knowledge-base.yaml

code/Test_definitions/qa-assistant-service.feature

documentation/API_documentation/knowledge-base-API-Readiness-Checklist.md

documentation/API_documentation/qa-assistant-service-API-Readiness-Checklist.md

tanjadegroot · 2025-09-18T01:30:29Z

@lihaojie-CMCC, Team, any idea when you can do the updates (most are straightforward fixes) so we can go ahead and approve for merge and release.
We are targeting M4 and M5 (publication of the meta-release) in the TSC meeting tomorrow (4PM CEST).
thanks !

Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

…hecklist.md Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

…ness-Checklist.md Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

lihaojie-CMCC · 2025-09-18T04:01:17Z

@lihaojie-CMCC, Team, any idea when you can do the updates (most are straightforward fixes) so we can go ahead and approve for merge and release. We are targeting M4 and M5 (publication of the meta-release) in the TSC meeting tomorrow (4PM CEST). thanks !

Hi @tanjadegroot , Thank you so much for your comments. They are incredibly valuable to our project. We have implemented all the suggestions and completed the updates. Please take a look when you have a moment.
Also, sorry for the delayed response!

tanjadegroot

Many thanks @lihaojie-CMCC for the quick update !
A left a few comments still but you can decide if you do them before merging or if you leave them to the next release (as they do not impact the API usage)

All the rest looks great ! thanks

LGTM from Release Management

After the merge, please create the release and update the release trackers on the wiki - many thanks !

README.md

tanjadegroot · 2025-09-18T09:36:57Z

code/API_definitions/knowledge-base.yaml

    It is designed to provide applications with standardized capabilities for knowledge content storage and management, supporting multi-format document storage, fine-grained permission control, and end-to-end traceability.
    It is suitable for building knowledge-intensive systems (such as intelligent customer service platforms and enterprise document platforms) while ensuring compliance.
-
+    It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ.


this text should actually be part of the schema definition you can copy it from https://github.com/camaraproject/Commonalities/blob/main/artifacts/CAMARA_common.yaml

Same for all yaml files using date-time type attributes

tanjadegroot · 2025-09-18T09:38:20Z

code/API_definitions/qa-assistant-manage.yaml

  description: >-
    This API provides CRUD (Create, Read, Update, Delete) management functions for the Question and Answer (Q&A) Assistant, aiming to equip developers with the capability to configure and manage intelligent question-answering systems based on Large Language Models (LLMs).
    It supports model parameter tuning, knowledge base association, and prompt engineering configuration, making it suitable for building customizable intelligent customer service or question-answering services.
+    It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ.


Same comment as above on date-time based schemas

tanjadegroot · 2025-09-18T09:38:41Z

code/API_definitions/qa-assistant-service.yaml

  description: >-
    This API provides service interfaces for the Question and Answer (Q&A) Assistant, enabling users to submit query requests to a configured Q&A assistant and obtain answers generated based on the knowledge base and Large Language Model (LLM).
    It is suitable for scenarios such as building intelligent question-answering systems and customer service bots that require real-time responses to user inquiries.
+    It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ.


Same comment as above on date-time based schemas

Co-authored-by: Herbert Damker <herbert.damker@telekom.de>

lihaojie-CMCC · 2025-09-18T13:55:07Z

Thanks everyone for the review and feedback! I'm going to go ahead and merge this PR.
The relevant revisions will be addressed in the next release.

lihaojie-CMCC · 2025-09-18T14:07:11Z

@hdamker @tanjadegroot , As we've just revised the "consumer" related content, we would like to seek your assistance for a final confirmation from the Release Management side. We greatly appreciate your support!

tanjadegroot

All good - thanks very much for the updates !!

LGTM from Release Management

Update knowledge-base.yaml

58cf10a

Update README.md for Fall25 M4

0536650

lihaojie-CMCC requested a review from a team August 27, 2025 06:21

lihaojie-CMCC added 5 commits August 27, 2025 14:25

Update qa-assistant-manage.yaml for Fall25 M4

c912257

Update qa-assistant-service.yaml for Fall25 M4

096b303

Update knowledge-base.feature for Fall25 M4

0b91030

Update qa-assistant-manage.feature

efd0984

Update qa-assistant-service.feature

d036439

hdamker marked this pull request as draft August 27, 2025 06:41

lihaojie-CMCC added the Fall25 label Aug 27, 2025

Kevsy mentioned this pull request Aug 28, 2025

ModelAsAService r1.2 (Fall25 M4) release review camaraproject/ReleaseManagement#311

Closed

34 tasks

lihaojie-CMCC changed the title ~~Public Release r1.1 for ModelAsAService APIs (Fall25 M4)~~ Public Release r1.2 for ModelAsAService APIs (Fall25 M4) Aug 28, 2025

lihaojie-CMCC added 15 commits August 28, 2025 18:50

Merge branch 'main' into lihaojie-CMCC-patch-1

d8b5d1e

Update knowledge-base.feature

d809450

Update qa-assistant-manage.feature

9460f3d

Update qa-assistant-service.feature

838e482

Update CHANGELOG.md

de26013

Update README.md

439d271

Create ModelAsAService_knowledge_base_User_Story.md

58014e7

Create ModelAsAService_qa_assistant_manage_User_Story.md

8866044

Update ModelAsAService_qa_assistant_manage_User_Story.md

8c9241a

Create ModelAsAService_qa_assistant_service_User_Story.md

4050d5b

Create ModelAsAService_knowledge_base_and_qa_assistant_User_Story.md

ab049cc

Update and rename knowledge-base-API-Readiness-Checklist to knowledge…

508b2d9

…-base-API-Readiness-Checklist.md

Update and rename qa-assistant-manage-API-Readiness-Checklist to qa-a…

7849aaa

…ssistant-manage-API-Readiness-Checklist.md

Update knowledge-base-API-Readiness-Checklist.md

d4d9a58

Update and rename qa-assistant-service-API-Readiness-Checklist to qa-…

f2cf834

…assistant-service-API-Readiness-Checklist.md

lihaojie-CMCC marked this pull request as ready for review August 28, 2025 12:39

tanjadegroot requested changes Sep 16, 2025

View reviewed changes

lihaojie-CMCC and others added 16 commits September 18, 2025 10:14

Update README.md

be23e10

Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

Update README.md

3916440

Update knowledge-base.yaml

228c5ab

Update qa-assistant-manage.yaml

8e688e9

Update qa-assistant-service.yaml

4afff11

Update code/Test_definitions/knowledge-base.feature

6034ef6

Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

Update code/Test_definitions/qa-assistant-manage.feature

0c54411

Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

Update code/Test_definitions/qa-assistant-service.feature

4935c17

Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

Update documentation/API_documentation/knowledge-base-API-Readiness-C…

5e560dc

…hecklist.md Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

Update documentation/API_documentation/qa-assistant-service-API-Readi…

0e30078

…ness-Checklist.md Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

Update documentation/API_documentation/qa-assistant-service-API-Readi…

6c1755e

…ness-Checklist.md Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

Update documentation/API_documentation/qa-assistant-service-API-Readi…

60ce7b2

…ness-Checklist.md Co-authored-by: Tanja de Groot <87864067+tanjadegroot@users.noreply.github.com>

Update qa-assistant-manage-API-Readiness-Checklist.md

ac0a738

Update qa-assistant-service-API-Readiness-Checklist.md

544efa3

Update qa-assistant-manage.yaml

0b173d3

Update qa-assistant-service.yaml

aa61b89

tanjadegroot previously approved these changes Sep 18, 2025

View reviewed changes

Update README.md

d6d6883

Co-authored-by: Herbert Damker <herbert.damker@telekom.de>

lihaojie-CMCC dismissed tanjadegroot’s stale review via d6d6883 September 18, 2025 13:19

tanjadegroot approved these changes Sep 18, 2025

View reviewed changes

lihaojie-CMCC merged commit 2a21956 into main Sep 18, 2025
2 checks passed

Conversation

lihaojie-CMCC commented Aug 26, 2025

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Uh oh!

github-actions bot commented Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦙 MegaLinter status: ✅ SUCCESS

Uh oh!

lihaojie-CMCC commented Aug 26, 2025

Uh oh!

hdamker commented Aug 27, 2025

Uh oh!

lihaojie-CMCC commented Aug 28, 2025

Uh oh!

tanjadegroot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tanjadegroot commented Sep 18, 2025

Uh oh!

lihaojie-CMCC commented Sep 18, 2025

Uh oh!

tanjadegroot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

tanjadegroot Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

tanjadegroot Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

tanjadegroot Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

lihaojie-CMCC commented Sep 18, 2025

Uh oh!

lihaojie-CMCC commented Sep 18, 2025

Uh oh!

tanjadegroot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Aug 26, 2025 •

edited

Loading

tanjadegroot left a comment •

edited

Loading