semantic-lady 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -0
- package/LICENSE +201 -0
- package/README.md +283 -0
- package/dist/index.cjs +18236 -0
- package/dist/index.d.cts +12357 -0
- package/dist/index.d.ts +12357 -0
- package/dist/index.js +18198 -0
- package/package.json +70 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes will be documented here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
4
|
+
|
|
5
|
+
## Unreleased
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
|
|
9
|
+
- Added the public Semantic Lady SDK package with a generated local model schema catalog.
|
|
10
|
+
- Added resolver helpers for model lookup, model summaries, and `core`, `advanced`, and `full` schema views.
|
|
11
|
+
- Added OSS utility files, GitHub issue templates, pull request template, Dependabot config, and package/security workflows.
|
|
12
|
+
|
|
13
|
+
### Security
|
|
14
|
+
|
|
15
|
+
- Documented the BYOK boundary: Semantic Lady contains no backend client, provider credentials, hosted API calls, telemetry, or provider execution path.
|
|
16
|
+
|
|
17
|
+
## [0.1.0] - 2026-06-09
|
|
18
|
+
|
|
19
|
+
### Added
|
|
20
|
+
|
|
21
|
+
- Initial public SDK release candidate for normalized `generation_*` image and video model schemas.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 BabySea, Inc.
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,283 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# Semantic Lady
|
|
4
|
+
|
|
5
|
+
Schema unification SDK for generative media model APIs.
|
|
6
|
+
|
|
7
|
+
### One generation schema across image and video models.
|
|
8
|
+
|
|
9
|
+
<br />
|
|
10
|
+
|
|
11
|
+
<strong>Project details</strong>
|
|
12
|
+
|
|
13
|
+
[](#babysea-oss-taxonomy)
|
|
14
|
+
[](#status)
|
|
15
|
+
[](LICENSE)
|
|
16
|
+
|
|
17
|
+
<br/>
|
|
18
|
+
|
|
19
|
+
<strong>Checks</strong>
|
|
20
|
+
|
|
21
|
+
[](https://gitlab.com/babysea/semantic-lady/-/commits/main)
|
|
22
|
+
[](https://github.com/babysea-community/semantic-lady/actions/workflows/sentry-check.yml)
|
|
23
|
+
[](https://github.com/babysea-community/semantic-lady/actions/workflows/codeql.yml)
|
|
24
|
+
[](https://github.com/babysea-community/semantic-lady/actions/workflows/package-check.yml)
|
|
25
|
+
|
|
26
|
+
<br/>
|
|
27
|
+
|
|
28
|
+
<strong>Built with</strong>
|
|
29
|
+
|
|
30
|
+
[](https://www.typescriptlang.org)
|
|
31
|
+
[](https://nodejs.org)
|
|
32
|
+
[](https://www.npmjs.com)
|
|
33
|
+
[](#4-boundaries)
|
|
34
|
+
|
|
35
|
+
</div>
|
|
36
|
+
|
|
37
|
+
<br/>
|
|
38
|
+
|
|
39
|
+
## BabySea OSS taxonomy
|
|
40
|
+
|
|
41
|
+
BabySea open source projects are organized into three categories:
|
|
42
|
+
|
|
43
|
+
[](#babysea-oss-taxonomy)
|
|
44
|
+
[](#babysea-oss-taxonomy)
|
|
45
|
+
[](#babysea-oss-taxonomy)
|
|
46
|
+
|
|
47
|
+
| Category | Description |
|
|
48
|
+
| :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
49
|
+
| **SDK** | Typed developer entry points that applications import directly. Semantic Lady is an SDK because it ships local model/schema resolver APIs. |
|
|
50
|
+
| **Primitive** | Reusable infrastructure boundaries extracted from BabySea's execution control plane. Each primitive focuses on one system concern. |
|
|
51
|
+
| **Starter** | Deployable reference applications that combine product UI, auth, storage, and generative media execution patterns. Some starters may include billing. |
|
|
52
|
+
|
|
53
|
+
## Status
|
|
54
|
+
|
|
55
|
+
BabySea OSS projects are published into three status levels:
|
|
56
|
+
|
|
57
|
+
[](#status)
|
|
58
|
+
[](#status)
|
|
59
|
+
[](#status)
|
|
60
|
+
|
|
61
|
+
| Status | Description |
|
|
62
|
+
| :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
63
|
+
| **Working** | Fully implemented and usable. All documented capabilities function as described. Suitable for personal and small-team use. No breaking-change guarantees between versions. |
|
|
64
|
+
| **Production** | Working plus a hardened public runtime contract. Validated against a stated infrastructure stack with deterministic behavior, explicit failure modes, and a documented upgrade path. |
|
|
65
|
+
| **Alpha** | Early-stage implementation. Core structure exists but some capabilities may be incomplete, undocumented, or subject to breaking changes. Not recommended for production deployments. |
|
|
66
|
+
|
|
67
|
+
## Table of contents
|
|
68
|
+
|
|
69
|
+
1. [Overview](#1-overview)
|
|
70
|
+
- [What this is](#what-this-is)
|
|
71
|
+
- [Short version](#short-version)
|
|
72
|
+
- [Production lineage](#production-lineage)
|
|
73
|
+
- [Grounding rule](#grounding-rule)
|
|
74
|
+
- [Adoption path](#adoption-path)
|
|
75
|
+
2. [Schema contract](#2-schema-contract)
|
|
76
|
+
3. [Terminology](#3-terminology)
|
|
77
|
+
4. [Boundaries](#4-boundaries)
|
|
78
|
+
5. [Architecture](#5-architecture)
|
|
79
|
+
6. [Quick start](#6-quick-start)
|
|
80
|
+
- [Install](#install)
|
|
81
|
+
- [List models](#list-models)
|
|
82
|
+
- [Resolve a model schema](#resolve-a-model-schema)
|
|
83
|
+
- [Build UI controls](#build-ui-controls)
|
|
84
|
+
7. [Core capabilities](#7-core-capabilities)
|
|
85
|
+
- [What it normalizes](#what-it-normalizes)
|
|
86
|
+
- [Model ordering](#model-ordering)
|
|
87
|
+
- [Schema tiers](#schema-tiers)
|
|
88
|
+
- [BYOK usage](#byok-usage)
|
|
89
|
+
8. [Version surface](#8-version-surface)
|
|
90
|
+
9. [Security and Compliance](#9-security-and-compliance)
|
|
91
|
+
10. [Community](#10-community)
|
|
92
|
+
- [Who's using it](#whos-using-it)
|
|
93
|
+
- [Related projects](#related-projects)
|
|
94
|
+
- [Contributing](#contributing)
|
|
95
|
+
11. [License](#11-license)
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
## 1. Overview
|
|
99
|
+
|
|
100
|
+
### What this is
|
|
101
|
+
|
|
102
|
+
`semantic-lady` is a local TypeScript SDK for resolving generative media model schemas into one normalized `generation_*` field contract.
|
|
103
|
+
|
|
104
|
+
It helps BYOK products, workflow builders, and community tools present many provider models through one consistent schema vocabulary without calling BabySea, running a backend, or wrapping provider SDKs.
|
|
105
|
+
|
|
106
|
+
### Short version
|
|
107
|
+
|
|
108
|
+
Different inference providers name the same ideas differently. Semantic Lady exposes a resolved catalog where model IDs, UI names, field names, field types, defaults, enum values, placeholders, and schema tiers are normalized for application code.
|
|
109
|
+
|
|
110
|
+
### Production lineage
|
|
111
|
+
|
|
112
|
+
Semantic Lady is extracted from the schema work used to make BabySea and BabyChain handle provider growth without hard-coding every UI and request shape by hand. The public SDK exposes the normalized contract, not BabySea's private schema compiler or provider-mapping internals.
|
|
113
|
+
|
|
114
|
+
### Grounding rule
|
|
115
|
+
|
|
116
|
+
Public OSS behavior is limited to local schema discovery and schema resolution. The package ships model metadata and normalized `generation_*` fields. It does not submit generations, store credentials, call provider APIs, call BabySea APIs, choose providers, price workloads, or manage execution.
|
|
117
|
+
|
|
118
|
+
### Adoption path
|
|
119
|
+
|
|
120
|
+
Install the SDK, list available image/video models, resolve the schema for the selected model, render fields in your UI, collect user input, then pass that input to your own BYOK provider integration.
|
|
121
|
+
|
|
122
|
+
## 2. Schema contract
|
|
123
|
+
|
|
124
|
+
| Surface | Contract |
|
|
125
|
+
| :------------ | :------------------------------------------------------------------------------------------------- |
|
|
126
|
+
| Model names | Stable API names such as `bfl/flux-2-pro`, plus user-facing UI names for pickers and labels. |
|
|
127
|
+
| Model groups | Separate image and video model arrays, plus one combined array ordered by provider and API name. |
|
|
128
|
+
| Fields | Normalized `generation_*` names such as `generation_prompt`, `generation_ratio`, and media inputs. |
|
|
129
|
+
| Field shape | Type, required flag, default, enum values, min/max, placeholder, description, and schema tier. |
|
|
130
|
+
| Schema views | `core`, `advanced`, and `full` views for compact UI controls or complete model forms. |
|
|
131
|
+
|
|
132
|
+
The public package is data plus local resolver helpers. It is safe to use in server-side code, build tools, CLIs, and browser bundles where the generated catalog size is acceptable.
|
|
133
|
+
|
|
134
|
+
## 3. Terminology
|
|
135
|
+
|
|
136
|
+
| Term | Meaning in this package |
|
|
137
|
+
| :-------------------- | :------------------------------------------------------------------------------------------------------- |
|
|
138
|
+
| Semantic model | One supported image or video model with an API name, UI name, provider, workflows, and resolved schema. |
|
|
139
|
+
| API name | Stable model identifier used by application code, for example `google/veo-3.1-fast`. |
|
|
140
|
+
| UI name | Human-readable model label for menus and forms. |
|
|
141
|
+
| Normalized field | A provider-neutral field named with the `generation_*` prefix. |
|
|
142
|
+
| Core schema | The fields most users need first, ordered for predictable UI rendering. |
|
|
143
|
+
| Advanced schema | Less common controls, ordered alphabetically after core fields. |
|
|
144
|
+
| BYOK | Bring your own key: your application owns provider credentials and provider execution. |
|
|
145
|
+
|
|
146
|
+
## 4. Boundaries
|
|
147
|
+
|
|
148
|
+
- Not a hosted API, backend client, or network SDK.
|
|
149
|
+
- Not a provider SDK wrapper and not a generation submission tool.
|
|
150
|
+
- Not a credential store, proxy, queue, pricing engine, or provider router.
|
|
151
|
+
- Not BabySea's private schema compiler, raw provider-doc parser, alias map, or provider payload mapper.
|
|
152
|
+
- Not a replacement for your BYOK integration. It gives your app the normalized schema contract your BYOK integration can consume.
|
|
153
|
+
|
|
154
|
+
## 5. Architecture
|
|
155
|
+
|
|
156
|
+
```text
|
|
157
|
+
Private schema source
|
|
158
|
+
|
|
|
159
|
+
v
|
|
160
|
+
Resolved public catalog
|
|
161
|
+
|
|
|
162
|
+
v
|
|
163
|
+
semantic-lady local SDK
|
|
164
|
+
|
|
|
165
|
+
v
|
|
166
|
+
Your BYOK app UI / workflow builder / provider adapter
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
The public SDK exports generated, normalized catalog data and small resolver helpers. Your application remains responsible for provider credentials, provider calls, retries, storage, billing, and moderation policy.
|
|
170
|
+
|
|
171
|
+
## 6. Quick start
|
|
172
|
+
|
|
173
|
+
### Install
|
|
174
|
+
|
|
175
|
+
```bash
|
|
176
|
+
pnpm add semantic-lady
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
```bash
|
|
180
|
+
npm install semantic-lady
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### List models
|
|
184
|
+
|
|
185
|
+
```typescript
|
|
186
|
+
import {
|
|
187
|
+
SEMANTIC_LADY_IMAGE_MODELS,
|
|
188
|
+
SEMANTIC_LADY_VIDEO_MODELS,
|
|
189
|
+
listModelSummaries,
|
|
190
|
+
} from 'semantic-lady';
|
|
191
|
+
|
|
192
|
+
const models = listModelSummaries();
|
|
193
|
+
const imageModelCount = SEMANTIC_LADY_IMAGE_MODELS.length;
|
|
194
|
+
const videoModelCount = SEMANTIC_LADY_VIDEO_MODELS.length;
|
|
195
|
+
|
|
196
|
+
console.log(models[0]?.apiName, imageModelCount, videoModelCount);
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
### Resolve a model schema
|
|
200
|
+
|
|
201
|
+
```typescript
|
|
202
|
+
import { getModelSchema } from 'semantic-lady';
|
|
203
|
+
|
|
204
|
+
const schema = getModelSchema('bfl/flux-2-pro', 'full');
|
|
205
|
+
|
|
206
|
+
for (const field of schema.fields) {
|
|
207
|
+
console.log(field.name, field.type, field.required ?? false);
|
|
208
|
+
}
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Build UI controls
|
|
212
|
+
|
|
213
|
+
```typescript
|
|
214
|
+
import { getModelCoreSchema } from 'semantic-lady';
|
|
215
|
+
|
|
216
|
+
const core = getModelCoreSchema('google/veo-3.1-fast');
|
|
217
|
+
|
|
218
|
+
const controls = core.fields.map((field) => ({
|
|
219
|
+
key: field.name,
|
|
220
|
+
label: field.description,
|
|
221
|
+
options: field.enum,
|
|
222
|
+
placeholder: field.placeholder,
|
|
223
|
+
required: field.required ?? false,
|
|
224
|
+
type: field.type,
|
|
225
|
+
}));
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
## 7. Core capabilities
|
|
229
|
+
|
|
230
|
+
### What it normalizes
|
|
231
|
+
|
|
232
|
+
Semantic Lady normalizes model names for APIs, model names for UIs, and provider field shapes into one `generation_*` schema vocabulary.
|
|
233
|
+
|
|
234
|
+
Examples of normalized field names include:
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
### Model ordering
|
|
238
|
+
|
|
239
|
+
The exported model catalog is ordered by inference provider first, then model API name alphabetically. Image and video models are also exported separately for products that need media-type tabs or filters.
|
|
240
|
+
|
|
241
|
+
### Schema tiers
|
|
242
|
+
|
|
243
|
+
`core` fields are designed for the first screen of a model form. `advanced` fields are available for complete model control. `full` returns both tiers in deterministic order.
|
|
244
|
+
|
|
245
|
+
### BYOK usage
|
|
246
|
+
|
|
247
|
+
Semantic Lady is meant for BYOK applications. It never asks for provider keys and never sends requests. Use it to decide which fields your app should collect, then map the normalized input inside your own provider adapter.
|
|
248
|
+
|
|
249
|
+
## 8. Version surface
|
|
250
|
+
|
|
251
|
+
Current version surface:
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
New behavior stays out of the public contract until it is implemented, documented, and covered by package tests.
|
|
255
|
+
|
|
256
|
+
## 9. Security and Compliance
|
|
257
|
+
|
|
258
|
+
Semantic Lady is a local schema SDK. It contains no provider credentials, no hosted endpoint, no telemetry client, and no network request path.
|
|
259
|
+
|
|
260
|
+
| Signal | Coverage |
|
|
261
|
+
| :---------------- | :-------------------------------------------------------------------------------------------------------- |
|
|
262
|
+
| Secret exposure | The package does not accept, store, or transmit provider keys. |
|
|
263
|
+
| BYOK boundary | Provider execution remains in the caller's application or infrastructure. |
|
|
264
|
+
| Public catalog | The published data is the normalized schema contract, not raw provider-doc extraction or private compiler logic. |
|
|
265
|
+
| Package checks | TypeScript typecheck, tests, and build verify the public resolver API before release. |
|
|
266
|
+
|
|
267
|
+
## 10. Community
|
|
268
|
+
|
|
269
|
+
### Who's using it
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
*Using `semantic-lady`? Open a PR to add yourself.*
|
|
273
|
+
|
|
274
|
+
### Related projects
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
### Contributing
|
|
278
|
+
|
|
279
|
+
We welcome PRs, issues, and design discussion. Keep changes focused on the public schema contract and avoid adding provider credentials, hosted API clients, or network behavior to this SDK.
|
|
280
|
+
|
|
281
|
+
## 11. License
|
|
282
|
+
|
|
283
|
+
[Apache License 2.0](LICENSE). Use it, fork it, ship it.
|