Skip to content

Commit d694111

Browse files
authored
Merge pull request #1891 from tisnik/lcore-2086-regenerated-config-doc
LCORE-2086: Regenerated config doc
2 parents f3335b8 + c0fb0f1 commit d694111

3 files changed

Lines changed: 77 additions & 6 deletions

File tree

docs/config.html

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -493,6 +493,36 @@ <h2 id="byokrag">ByokRag</h2>
493493
to weight results when querying multiple knowledge sources. Values &gt;
494494
1 boost this store&#x2019;s results; values &lt; 1 reduce them.</td>
495495
</tr>
496+
<tr class="even">
497+
<td>host</td>
498+
<td>string</td>
499+
<td>PostgreSQL host for remote::pgvector. Defaults to
500+
${env.POSTGRES_HOST} when rag_type is remote::pgvector.</td>
501+
</tr>
502+
<tr class="odd">
503+
<td>port</td>
504+
<td>string</td>
505+
<td>PostgreSQL port for remote::pgvector. Defaults to
506+
${env.POSTGRES_PORT} when rag_type is remote::pgvector.</td>
507+
</tr>
508+
<tr class="even">
509+
<td>db</td>
510+
<td>string</td>
511+
<td>PostgreSQL database name for remote::pgvector. Defaults to
512+
${env.POSTGRES_DATABASE} when rag_type is remote::pgvector.</td>
513+
</tr>
514+
<tr class="odd">
515+
<td>user</td>
516+
<td>string</td>
517+
<td>PostgreSQL user for remote::pgvector. Defaults to
518+
${env.POSTGRES_USER} when rag_type is remote::pgvector.</td>
519+
</tr>
520+
<tr class="even">
521+
<td>password</td>
522+
<td>string</td>
523+
<td>PostgreSQL password for remote::pgvector. Defaults to
524+
${env.POSTGRES_PASSWORD} when rag_type is remote::pgvector.</td>
525+
</tr>
496526
</tbody>
497527
</table>
498528
<h2 id="corsconfiguration">CORSConfiguration</h2>

docs/config.json

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@
316316
},
317317
"rag_type": {
318318
"default": "inline::faiss",
319-
"description": "Type of RAG database.",
319+
"description": "Type of RAG database (e.g. 'inline::faiss', 'remote::pgvector').",
320320
"minLength": 1,
321321
"title": "RAG type",
322322
"type": "string"
@@ -342,22 +342,58 @@
342342
"type": "string"
343343
},
344344
"db_path": {
345-
"description": "Path to RAG database.",
346-
"title": "DB path",
347-
"type": "string"
345+
"type": "string",
346+
"nullable": true,
347+
"default": null,
348+
"description": "Path to RAG database. Required for inline::faiss.",
349+
"title": "DB path"
348350
},
349351
"score_multiplier": {
350352
"default": 1.0,
351353
"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.",
352354
"minimum": 0,
353355
"title": "Score multiplier",
354356
"type": "number"
357+
},
358+
"host": {
359+
"type": "string",
360+
"nullable": true,
361+
"default": null,
362+
"description": "PostgreSQL host for remote::pgvector. Defaults to ${env.POSTGRES_HOST} when rag_type is remote::pgvector.",
363+
"title": "PostgreSQL host"
364+
},
365+
"port": {
366+
"type": "string",
367+
"nullable": true,
368+
"default": null,
369+
"description": "PostgreSQL port for remote::pgvector. Defaults to ${env.POSTGRES_PORT} when rag_type is remote::pgvector.",
370+
"title": "PostgreSQL port"
371+
},
372+
"db": {
373+
"type": "string",
374+
"nullable": true,
375+
"default": null,
376+
"description": "PostgreSQL database name for remote::pgvector. Defaults to ${env.POSTGRES_DATABASE} when rag_type is remote::pgvector.",
377+
"title": "PostgreSQL database"
378+
},
379+
"user": {
380+
"type": "string",
381+
"nullable": true,
382+
"default": null,
383+
"description": "PostgreSQL user for remote::pgvector. Defaults to ${env.POSTGRES_USER} when rag_type is remote::pgvector.",
384+
"title": "PostgreSQL user"
385+
},
386+
"password": {
387+
"type": "string",
388+
"nullable": true,
389+
"default": null,
390+
"description": "PostgreSQL password for remote::pgvector. Defaults to ${env.POSTGRES_PASSWORD} when rag_type is remote::pgvector.",
391+
"title": "PostgreSQL password"
355392
}
356393
},
357394
"required": [
358395
"rag_id",
359-
"vector_db_id",
360-
"db_path"
396+
"vector_db_id"
361397
],
362398
"title": "ByokRag",
363399
"type": "object"

docs/config.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,11 @@ BYOK (Bring Your Own Knowledge) RAG configuration.
155155
| vector_db_id | string | Vector database identification. |
156156
| db_path | string | Path to RAG database. |
157157
| score_multiplier | number | 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. |
158+
| host | string | PostgreSQL host for remote::pgvector. Defaults to ${env.POSTGRES_HOST} when rag_type is remote::pgvector. |
159+
| port | string | PostgreSQL port for remote::pgvector. Defaults to ${env.POSTGRES_PORT} when rag_type is remote::pgvector. |
160+
| db | string | PostgreSQL database name for remote::pgvector. Defaults to ${env.POSTGRES_DATABASE} when rag_type is remote::pgvector. |
161+
| user | string | PostgreSQL user for remote::pgvector. Defaults to ${env.POSTGRES_USER} when rag_type is remote::pgvector. |
162+
| password | string | PostgreSQL password for remote::pgvector. Defaults to ${env.POSTGRES_PASSWORD} when rag_type is remote::pgvector. |
158163

159164

160165
## CORSConfiguration

0 commit comments

Comments
 (0)