Skip to content

Commit a491022

Browse files
authored
Merge pull request #1332 from tisnik/lcore-1356-regenerated-doc
LCORE-1356: regenerated doc
2 parents 9742c74 + 5c9d22f commit a491022

7 files changed

Lines changed: 786 additions & 544 deletions

File tree

docs/config.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1399,9 +1399,9 @@ <h2 id="ragconfiguration">RagConfiguration</h2>
13991399
other IDs refer to entries in <code>byok_rag</code>.</p>
14001400
<p>Backward compatibility: - <code>inline</code> defaults to
14011401
<code>[]</code> (no inline RAG). - <code>tool</code> defaults to
1402-
<code>None</code> which means all registered vector stores are used
1403-
(identical to the previous <code>tool.byok.enabled = True</code>
1404-
default).</p>
1402+
<code>[]</code> (no tool RAG).</p>
1403+
<p>If no RAG strategy is defined (inline and tool are empty), the RAG
1404+
tool will register all stores available to llama-stack.</p>
14051405
<table>
14061406
<colgroup>
14071407
<col style="width: 26%"/>

docs/config.json

Lines changed: 60 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -282,9 +282,15 @@
282282
},
283283
"db_path": {
284284
"description": "Path to RAG database.",
285-
"format": "file-path",
286285
"title": "DB path",
287286
"type": "string"
287+
},
288+
"score_multiplier": {
289+
"default": 1.0,
290+
"description": "Multiplier applied to relevance scores from this vector store. Used to weight results when querying multiple knowledge sources. Values > 1 boost this store's results; values < 1 reduce them.",
291+
"minimum": 0,
292+
"title": "Score multiplier",
293+
"type": "number"
288294
}
289295
},
290296
"required": [
@@ -467,18 +473,15 @@
467473
"title": "Deployment environment",
468474
"type": "string"
469475
},
470-
"solr": {
471-
"anyOf": [
472-
{
473-
"$ref": "#/components/schemas/SolrConfiguration"
474-
},
475-
{
476-
"type": "null"
477-
}
478-
],
479-
"default": null,
480-
"description": "Configuration for Solr vector search operations.",
481-
"title": "Solr configuration"
476+
"rag": {
477+
"$ref": "#/components/schemas/RagConfiguration",
478+
"description": "Configuration for all RAG strategies (inline and tool-based).",
479+
"title": "RAG configuration"
480+
},
481+
"okp": {
482+
"$ref": "#/components/schemas/OkpConfiguration",
483+
"description": "OKP provider settings. Only used when 'okp' is listed in rag.inline or rag.tool.",
484+
"title": "OKP configuration"
482485
}
483486
},
484487
"required": [
@@ -898,6 +901,26 @@
898901
"title": "ModelContextProtocolServer",
899902
"type": "object"
900903
},
904+
"OkpConfiguration": {
905+
"additionalProperties": false,
906+
"description": "OKP (Offline Knowledge Portal) provider configuration.\n\nControls provider-specific behaviour for the OKP vector store.\nOnly relevant when ``\"okp\"`` is listed in ``rag.inline`` or ``rag.tool``.",
907+
"properties": {
908+
"offline": {
909+
"default": true,
910+
"description": "When True, use parent_id for OKP chunk source URLs. When False, use reference_url for chunk source URLs.",
911+
"title": "OKP offline mode",
912+
"type": "boolean"
913+
},
914+
"chunk_filter_query": {
915+
"default": "is_chunk:true",
916+
"description": "OKP filter query applied to every OKP search request. Defaults to 'is_chunk:true' to restrict results to chunk documents. To add extra constraints, extend the expression using boolean syntax, e.g. 'is_chunk:true AND product:*openshift*'.",
917+
"title": "OKP chunk filter query",
918+
"type": "string"
919+
}
920+
},
921+
"title": "OkpConfiguration",
922+
"type": "object"
923+
},
901924
"PostgreSQLDatabaseConfiguration": {
902925
"additionalProperties": false,
903926
"description": "PostgreSQL database configuration.\n\nPostgreSQL database is used by Lightspeed Core Stack service for storing\ninformation about conversation IDs. It can also be leveraged to store\nconversation history and information about quota usage.\n\nUseful resources:\n\n- [Psycopg: connection classes](https://www.psycopg.org/psycopg3/docs/api/connections.html)\n- [PostgreSQL connection strings](https://www.connectionstrings.com/postgresql/)\n- [How to Use PostgreSQL in Python](https://www.freecodecamp.org/news/postgresql-in-python/)",
@@ -1110,6 +1133,30 @@
11101133
"title": "RHIdentityConfiguration",
11111134
"type": "object"
11121135
},
1136+
"RagConfiguration": {
1137+
"additionalProperties": false,
1138+
"description": "RAG strategy configuration.\n\nControls which RAG sources are used for inline and tool-based retrieval.\n\nEach strategy lists RAG IDs to include. The special ID ``\"okp\"`` defined in constants,\nactivates the OKP provider; all other IDs refer to entries in ``byok_rag``.\n\nBackward compatibility:\n - ``inline`` defaults to ``[]`` (no inline RAG).\n - ``tool`` defaults to ``[]`` (no tool RAG).\n\nIf no RAG strategy is defined (inline and tool are empty),\nthe RAG tool will register all stores available to llama-stack.",
1139+
"properties": {
1140+
"inline": {
1141+
"description": "RAG IDs whose sources are injected as context before the LLM call. Use 'okp' to enable OKP inline RAG. Empty by default (no inline RAG).",
1142+
"items": {
1143+
"type": "string"
1144+
},
1145+
"title": "Inline RAG IDs",
1146+
"type": "array"
1147+
},
1148+
"tool": {
1149+
"description": "RAG IDs made available to the LLM as a file_search tool. Use 'okp' to include the OKP vector store. When omitted, all registered BYOK vector stores are used (backward compatibility).",
1150+
"items": {
1151+
"type": "string"
1152+
},
1153+
"title": "Tool RAG IDs",
1154+
"type": "array"
1155+
}
1156+
},
1157+
"title": "RagConfiguration",
1158+
"type": "object"
1159+
},
11131160
"SQLiteDatabaseConfiguration": {
11141161
"additionalProperties": false,
11151162
"description": "SQLite database configuration.",
@@ -1195,26 +1242,6 @@
11951242
"title": "ServiceConfiguration",
11961243
"type": "object"
11971244
},
1198-
"SolrConfiguration": {
1199-
"additionalProperties": false,
1200-
"description": "Solr configuration for vector search queries.\n\nControls whether to use offline or online mode when building document URLs\nfrom vector search results, and enables/disables Solr vector IO functionality.",
1201-
"properties": {
1202-
"enabled": {
1203-
"default": false,
1204-
"description": "When True, enables Solr vector IO functionality for vector search queries. When False, disables Solr vector search processing.",
1205-
"title": "Solr enabled",
1206-
"type": "boolean"
1207-
},
1208-
"offline": {
1209-
"default": true,
1210-
"description": "When True, use parent_id for chunk source URLs. When False, use reference_url for chunk source URLs.",
1211-
"title": "Offline mode",
1212-
"type": "boolean"
1213-
}
1214-
},
1215-
"title": "SolrConfiguration",
1216-
"type": "object"
1217-
},
12181245
"SplunkConfiguration": {
12191246
"additionalProperties": false,
12201247
"description": "Splunk HEC (HTTP Event Collector) configuration.\n\nSplunk HEC allows sending events directly to Splunk over HTTP/HTTPS.\nThis configuration is used to send telemetry events for inference\nrequests to the corporate Splunk deployment.\n\nUseful resources:\n\n - [Splunk HEC Docs](https://docs.splunk.com/Documentation/SplunkCloud)\n - [About HEC](https://docs.splunk.com/Documentation/Splunk/latest/Data)",

docs/config.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -529,8 +529,10 @@ activates the OKP provider; all other IDs refer to entries in ``byok_rag``.
529529

530530
Backward compatibility:
531531
- ``inline`` defaults to ``[]`` (no inline RAG).
532-
- ``tool`` defaults to ``None`` which means all registered vector stores
533-
are used (identical to the previous ``tool.byok.enabled = True`` default).
532+
- ``tool`` defaults to ``[]`` (no tool RAG).
533+
534+
If no RAG strategy is defined (inline and tool are empty),
535+
the RAG tool will register all stores available to llama-stack.
534536

535537

536538
| Field | Type | Description |

docs/config.png

26.6 KB
Loading

docs/config.puml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ class "RHIdentityConfiguration" as src.models.config.RHIdentityConfiguration {
202202
}
203203
class "RagConfiguration" as src.models.config.RagConfiguration {
204204
inline : list[str]
205-
tool : Optional[list[str]]
205+
tool : list[str]
206206
}
207207
class "SQLiteDatabaseConfiguration" as src.models.config.SQLiteDatabaseConfiguration {
208208
db_path : str

0 commit comments

Comments
 (0)