Skip to content

Commit 3b1da38

Browse files
authored
Merge pull request lightspeed-core#2452 from tisnik/lcore-2922-regenerated
LCORE-2922: Regenerated devel doc
2 parents 83a953a + 6b64918 commit 3b1da38

11 files changed

Lines changed: 343 additions & 194 deletions

File tree

docs/models/common.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1610,16 +1610,17 @@
16101610
},
16111611
"SolrVectorSearchRequest": {
16121612
"additionalProperties": false,
1613-
"description": "LCORE Solr inline RAG options for vector_io.query (mode and provider filters).\n\nAttributes:\n mode: Solr vector_io search mode. When omitted, the server default (hybrid) is used.\n filters: Solr provider filter payload passed through as params['solr'].\n\nLegacy clients may send a plain JSON object with filter keys only;\nthat object is accepted as filters with mode unset (server default applies).",
1613+
"description": "LCORE Solr inline RAG options for vector_io.query (mode and provider filters).\n\nAttributes:\n mode: Solr vector_io search mode. When omitted, the configured OKP default is used.\n filters: Solr provider filter payload passed through as params['solr'].\n\nLegacy clients may send a plain JSON object with filter keys only;\nthat object is accepted as filters with mode unset (server default applies).",
16141614
"properties": {
16151615
"mode": {
16161616
"type": "string",
16171617
"nullable": true,
16181618
"default": null,
1619-
"description": "Solr vector_io search mode. When omitted, the server default ('hybrid') is used.",
1619+
"description": "Solr vector_io search mode. When omitted, the configured OKP default is used; otherwise 'hybrid' applies. 'keyword' and 'lexical' both use BM25 text search.",
16201620
"examples": [
16211621
"hybrid",
16221622
"semantic",
1623+
"keyword",
16231624
"lexical"
16241625
],
16251626
"title": "Mode"

docs/models/common.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -777,7 +777,7 @@ Attributes:
777777
LCORE Solr inline RAG options for vector_io.query (mode and provider filters).
778778

779779
Attributes:
780-
mode: Solr vector_io search mode. When omitted, the server default (hybrid) is used.
780+
mode: Solr vector_io search mode. When omitted, the configured OKP default is used.
781781
filters: Solr provider filter payload passed through as params['solr'].
782782

783783
Legacy clients may send a plain JSON object with filter keys only;
@@ -786,7 +786,7 @@ that object is accepted as filters with mode unset (server default applies).
786786

787787
| Field | Type | Description |
788788
|-------|------|-------------|
789-
| mode | string | Solr vector_io search mode. When omitted, the server default ('hybrid') is used. |
789+
| mode | string | Solr vector_io search mode. When omitted, the configured OKP default is used; otherwise 'hybrid' applies. 'keyword' and 'lexical' both use BM25 text search. |
790790
| filters | object | Solr provider filter payload passed through as params['solr']. Supports structured metadata filters (eq, ne, in, nin comparison operators). Legacy filter-only objects (e.g. fq) are still accepted. |
791791

792792

docs/models/common.puml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,7 +240,7 @@ class "SkillMetadata" as src.models.common.skills.SkillMetadata {
240240
}
241241
class "SolrVectorSearchRequest" as src.models.common.query.SolrVectorSearchRequest {
242242
filters : Optional[dict[str, Any]]
243-
mode : Optional[Literal['semantic', 'hybrid', 'lexical']]
243+
mode : Optional[Literal['semantic', 'hybrid', 'lexical', 'keyword']]
244244
model_config : ConfigDict
245245
coerce_legacy_plain_dict(data: Any) -> Any
246246
}

docs/models/common.svg

Lines changed: 21 additions & 21 deletions
Loading

docs/models/requests.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2657,16 +2657,17 @@
26572657
},
26582658
"SolrVectorSearchRequest": {
26592659
"additionalProperties": false,
2660-
"description": "LCORE Solr inline RAG options for vector_io.query (mode and provider filters).\n\nAttributes:\n mode: Solr vector_io search mode. When omitted, the server default (hybrid) is used.\n filters: Solr provider filter payload passed through as params['solr'].\n\nLegacy clients may send a plain JSON object with filter keys only;\nthat object is accepted as filters with mode unset (server default applies).",
2660+
"description": "LCORE Solr inline RAG options for vector_io.query (mode and provider filters).\n\nAttributes:\n mode: Solr vector_io search mode. When omitted, the configured OKP default is used.\n filters: Solr provider filter payload passed through as params['solr'].\n\nLegacy clients may send a plain JSON object with filter keys only;\nthat object is accepted as filters with mode unset (server default applies).",
26612661
"properties": {
26622662
"mode": {
26632663
"type": "string",
26642664
"nullable": true,
26652665
"default": null,
2666-
"description": "Solr vector_io search mode. When omitted, the server default ('hybrid') is used.",
2666+
"description": "Solr vector_io search mode. When omitted, the configured OKP default is used; otherwise 'hybrid' applies. 'keyword' and 'lexical' both use BM25 text search.",
26672667
"examples": [
26682668
"hybrid",
26692669
"semantic",
2670+
"keyword",
26702671
"lexical"
26712672
],
26722673
"title": "Mode"

docs/models/requests.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1194,7 +1194,7 @@ Examples:
11941194
LCORE Solr inline RAG options for vector_io.query (mode and provider filters).
11951195

11961196
Attributes:
1197-
mode: Solr vector_io search mode. When omitted, the server default (hybrid) is used.
1197+
mode: Solr vector_io search mode. When omitted, the configured OKP default is used.
11981198
filters: Solr provider filter payload passed through as params['solr'].
11991199

12001200
Legacy clients may send a plain JSON object with filter keys only;
@@ -1203,7 +1203,7 @@ that object is accepted as filters with mode unset (server default applies).
12031203

12041204
| Field | Type | Description |
12051205
|-------|------|-------------|
1206-
| mode | string | Solr vector_io search mode. When omitted, the server default ('hybrid') is used. |
1206+
| mode | string | Solr vector_io search mode. When omitted, the configured OKP default is used; otherwise 'hybrid' applies. 'keyword' and 'lexical' both use BM25 text search. |
12071207
| filters | object | Solr provider filter payload passed through as params['solr']. Supports structured metadata filters (eq, ne, in, nin comparison operators). Legacy filter-only objects (e.g. fq) are still accepted. |
12081208

12091209

0 commit comments

Comments
 (0)