Skip to content

Commit e6ef1f4

Browse files
tisniktisnik
authored
Merge pull request lightspeed-core#865 from tisnik/lcore-973-updated-generated-doc
LCORE-973: updated generated doc
2 parents 8aa441c + 3a24dee commit e6ef1f4

9 files changed

Lines changed: 866 additions & 596 deletions

File tree

‎docs/config.html‎

Lines changed: 95 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,10 @@
6060
img {
6161
max-width: 100%;
6262
}
63+
svg {
64+
height: auto;
65+
max-width: 100%;
66+
}
6367
h1, h2, h3, h4, h5, h6 {
6468
margin-top: 1.4em;
6569
}
@@ -163,17 +167,14 @@
163167
}
164168
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
165169
</style>
166-
<!--[if lt IE 9]>
167-
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
168-
<![endif]-->
169170
</head>
170171
<body>
171172
<header id="title-block-header">
172173
<h1 class="title"> </h1>
173174
</header>
174175
<h1 id="lightspeed-core-stack">Lightspeed Core Stack</h1>
175176
<hr />
176-
<h1 id="components">📋 Components</h1>
177+
<h1 id="configuration-schema">📋 Configuration schema</h1>
177178
<h2 id="accessrule">AccessRule</h2>
178179
<p>Rule defining what actions a role can perform.</p>
179180
<table>
@@ -188,17 +189,19 @@ <h2 id="accessrule">AccessRule</h2>
188189
<tr class="odd">
189190
<td>role</td>
190191
<td>string</td>
191-
<td></td>
192+
<td>Name of the role</td>
192193
</tr>
193194
<tr class="even">
194195
<td>actions</td>
195196
<td>array</td>
196-
<td></td>
197+
<td>Allowed actions for this role</td>
197198
</tr>
198199
</tbody>
199200
</table>
200201
<h2 id="action">Action</h2>
201202
<p>Available actions in the system.</p>
203+
<p>Note: this is not a real model, just an enumeration of all action
204+
names.</p>
202205
<h2 id="authenticationconfiguration">AuthenticationConfiguration</h2>
203206
<p>Authentication configuration.</p>
204207
<table>
@@ -256,12 +259,12 @@ <h2 id="authorizationconfiguration">AuthorizationConfiguration</h2>
256259
<tr class="odd">
257260
<td>access_rules</td>
258261
<td>array</td>
259-
<td></td>
262+
<td>Rules for role-based access control</td>
260263
</tr>
261264
</tbody>
262265
</table>
263266
<h2 id="byokrag">ByokRag</h2>
264-
<p>BYOK RAG configuration.</p>
267+
<p>BYOK (Bring Your Own Knowledge) RAG configuration.</p>
265268
<table>
266269
<thead>
267270
<tr class="header">
@@ -274,32 +277,32 @@ <h2 id="byokrag">ByokRag</h2>
274277
<tr class="odd">
275278
<td>rag_id</td>
276279
<td>string</td>
277-
<td></td>
280+
<td>Unique RAG ID</td>
278281
</tr>
279282
<tr class="even">
280283
<td>rag_type</td>
281284
<td>string</td>
282-
<td></td>
285+
<td>Type of RAG database.</td>
283286
</tr>
284287
<tr class="odd">
285288
<td>embedding_model</td>
286289
<td>string</td>
287-
<td></td>
290+
<td>Embedding model identification</td>
288291
</tr>
289292
<tr class="even">
290293
<td>embedding_dimension</td>
291294
<td>integer</td>
292-
<td></td>
295+
<td>Dimensionality of embedding vectors.</td>
293296
</tr>
294297
<tr class="odd">
295298
<td>vector_db_id</td>
296299
<td>string</td>
297-
<td></td>
300+
<td>Vector DB identification.</td>
298301
</tr>
299302
<tr class="even">
300303
<td>db_path</td>
301304
<td>string</td>
302-
<td></td>
305+
<td>Path to RAG database.</td>
303306
</tr>
304307
</tbody>
305308
</table>
@@ -470,6 +473,11 @@ <h2 id="configuration">Configuration</h2>
470473
id="conversationhistoryconfiguration">ConversationHistoryConfiguration</h2>
471474
<p>Conversation history configuration.</p>
472475
<table>
476+
<colgroup>
477+
<col style="width: 26%" />
478+
<col style="width: 23%" />
479+
<col style="width: 50%" />
480+
</colgroup>
473481
<thead>
474482
<tr class="header">
475483
<th>Field</th>
@@ -481,22 +489,23 @@ <h2 id="configuration">Configuration</h2>
481489
<tr class="odd">
482490
<td>type</td>
483491
<td>string</td>
484-
<td></td>
492+
<td>Type of database where the conversation history is to be
493+
stored.</td>
485494
</tr>
486495
<tr class="even">
487496
<td>memory</td>
488497
<td></td>
489-
<td></td>
498+
<td>In-memory cache configuration</td>
490499
</tr>
491500
<tr class="odd">
492501
<td>sqlite</td>
493502
<td></td>
494-
<td></td>
503+
<td>SQLite database configuration</td>
495504
</tr>
496505
<tr class="even">
497506
<td>postgres</td>
498507
<td></td>
499-
<td></td>
508+
<td>PostgreSQL database configuration</td>
500509
</tr>
501510
</tbody>
502511
</table>
@@ -514,12 +523,12 @@ <h2 id="customprofile">CustomProfile</h2>
514523
<tr class="odd">
515524
<td>path</td>
516525
<td>string</td>
517-
<td></td>
526+
<td>Path to Python modules containing custom profile.</td>
518527
</tr>
519528
<tr class="even">
520529
<td>prompts</td>
521530
<td>object</td>
522-
<td></td>
531+
<td>Dictionary containing map of system prompts</td>
523532
</tr>
524533
</tbody>
525534
</table>
@@ -610,6 +619,11 @@ <h2 id="inmemorycacheconfig">InMemoryCacheConfig</h2>
610619
<h2 id="inferenceconfiguration">InferenceConfiguration</h2>
611620
<p>Inference configuration.</p>
612621
<table>
622+
<colgroup>
623+
<col style="width: 26%" />
624+
<col style="width: 23%" />
625+
<col style="width: 50%" />
626+
</colgroup>
613627
<thead>
614628
<tr class="header">
615629
<th>Field</th>
@@ -621,20 +635,38 @@ <h2 id="inferenceconfiguration">InferenceConfiguration</h2>
621635
<tr class="odd">
622636
<td>default_model</td>
623637
<td>string</td>
624-
<td></td>
638+
<td>Identification of default model used when no other model is
639+
specified.</td>
625640
</tr>
626641
<tr class="even">
627642
<td>default_provider</td>
628643
<td>string</td>
629-
<td></td>
644+
<td>Identification of default provider used when no other model is
645+
specified.</td>
630646
</tr>
631647
</tbody>
632648
</table>
633649
<h2 id="jsonpathoperator">JsonPathOperator</h2>
634650
<p>Supported operators for JSONPath evaluation.</p>
651+
<p>Note: this is not a real model, just an enumeration of all supported
652+
JSONPath operators.</p>
635653
<h2 id="jwkconfiguration">JwkConfiguration</h2>
636-
<p>JWK configuration.</p>
654+
<p>JWK (JSON Web Key) configuration.</p>
655+
<p>A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data
656+
structure that represents a cryptographic key.</p>
657+
<p>Useful resources:</p>
658+
<ul>
659+
<li><a
660+
href="https://openid.net/specs/draft-jones-json-web-key-03.html">JSON
661+
Web Key</a></li>
662+
<li><a href="https://www.rfc-editor.org/rfc/rfc7517">RFC 7517</a></li>
663+
</ul>
637664
<table>
665+
<colgroup>
666+
<col style="width: 26%" />
667+
<col style="width: 23%" />
668+
<col style="width: 50%" />
669+
</colgroup>
638670
<thead>
639671
<tr class="header">
640672
<th>Field</th>
@@ -646,18 +678,38 @@ <h2 id="jwkconfiguration">JwkConfiguration</h2>
646678
<tr class="odd">
647679
<td>url</td>
648680
<td>string</td>
649-
<td></td>
681+
<td>HTTPS URL of the JWK (JSON Web Key) set used to validate JWTs.</td>
650682
</tr>
651683
<tr class="even">
652684
<td>jwt_configuration</td>
653685
<td></td>
654-
<td></td>
686+
<td>JWT (JSON Web Token) configuration</td>
655687
</tr>
656688
</tbody>
657689
</table>
658690
<h2 id="jwtconfiguration">JwtConfiguration</h2>
659-
<p>JWT configuration.</p>
691+
<p>JWT (JSON Web Token) configuration.</p>
692+
<p>JSON Web Token (JWT) is a compact, URL-safe means of representing
693+
claims to be transferred between two parties. The claims in a JWT are
694+
encoded as a JSON object that is used as the payload of a JSON Web
695+
Signature (JWS) structure or as the plaintext of a JSON Web Encryption
696+
(JWE) structure, enabling the claims to be digitally signed or integrity
697+
protected with a Message Authentication Code (MAC) and/or encrypted.</p>
698+
<p>Useful resources:</p>
699+
<ul>
700+
<li><a href="https://en.wikipedia.org/wiki/JSON_Web_Token">JSON Web
701+
Token</a></li>
702+
<li><a href="https://datatracker.ietf.org/doc/html/rfc7519">RFC
703+
7519</a></li>
704+
<li><a href="https://auth0.com/docs/secure/tokens/json-web-tokens">JSON
705+
Web Tokens</a></li>
706+
</ul>
660707
<table>
708+
<colgroup>
709+
<col style="width: 26%" />
710+
<col style="width: 23%" />
711+
<col style="width: 50%" />
712+
</colgroup>
661713
<thead>
662714
<tr class="header">
663715
<th>Field</th>
@@ -669,17 +721,17 @@ <h2 id="jwtconfiguration">JwtConfiguration</h2>
669721
<tr class="odd">
670722
<td>user_id_claim</td>
671723
<td>string</td>
672-
<td></td>
724+
<td>JWT claim name that uniquely identifies the user (subject ID).</td>
673725
</tr>
674726
<tr class="even">
675727
<td>username_claim</td>
676728
<td>string</td>
677-
<td></td>
729+
<td>JWT claim name that provides the human-readable username.</td>
678730
</tr>
679731
<tr class="odd">
680732
<td>role_rules</td>
681733
<td>array</td>
682-
<td></td>
734+
<td>Rules for extracting roles from JWT claims</td>
683735
</tr>
684736
</tbody>
685737
</table>
@@ -1045,7 +1097,7 @@ <h2 id="rhidentityconfiguration">RHIdentityConfiguration</h2>
10451097
<tr class="odd">
10461098
<td>required_entitlements</td>
10471099
<td>array</td>
1048-
<td></td>
1100+
<td>List of all required entitlements.</td>
10491101
</tr>
10501102
</tbody>
10511103
</table>
@@ -1183,6 +1235,11 @@ <h2 id="tlsconfiguration">TLSConfiguration</h2>
11831235
<h2 id="userdatacollection">UserDataCollection</h2>
11841236
<p>User data collection configuration.</p>
11851237
<table>
1238+
<colgroup>
1239+
<col style="width: 26%" />
1240+
<col style="width: 23%" />
1241+
<col style="width: 50%" />
1242+
</colgroup>
11861243
<thead>
11871244
<tr class="header">
11881245
<th>Field</th>
@@ -1194,22 +1251,26 @@ <h2 id="userdatacollection">UserDataCollection</h2>
11941251
<tr class="odd">
11951252
<td>feedback_enabled</td>
11961253
<td>boolean</td>
1197-
<td></td>
1254+
<td>When set to true the user feedback is stored and later sent for
1255+
analysis.</td>
11981256
</tr>
11991257
<tr class="even">
12001258
<td>feedback_storage</td>
12011259
<td>string</td>
1202-
<td></td>
1260+
<td>Path to directory where feedback will be saved for further
1261+
processing.</td>
12031262
</tr>
12041263
<tr class="odd">
12051264
<td>transcripts_enabled</td>
12061265
<td>boolean</td>
1207-
<td></td>
1266+
<td>When set to true the conversation history is stored and later sent
1267+
for analysis.</td>
12081268
</tr>
12091269
<tr class="even">
12101270
<td>transcripts_storage</td>
12111271
<td>string</td>
1212-
<td></td>
1272+
<td>Path to directory where conversation history will be saved for
1273+
further processing.</td>
12131274
</tr>
12141275
</tbody>
12151276
</table>

0 commit comments

Comments
 (0)