Skip to content

RHIDP-14076: add top-level vector store config #2200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tisnik merged 10 commits into from
Jul 28, 2026
Merged

RHIDP-14076: add top-level vector store config #2200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bec56a4
add vector store config classes and test
Jdubrick Jul 21, 2026
992f079
add vector stores to synthesizer
Jdubrick Jul 21, 2026
a0204d9
add vector stores to enricher
Jdubrick Jul 21, 2026
1205be8
update documentation
Jdubrick Jul 21, 2026
18a58a1
fix vector store types / refs
Jdubrick Jul 21, 2026
ba03f77
RHIDP-14076: fix pylint locals and regenerate OpenAPI schema
Jdubrick Jul 21, 2026
d12e99b
address coderabbit review
Jdubrick Jul 21, 2026
06f85e2
use dedicated default field instead of boolean
Jdubrick Jul 27, 2026
ca95dd3
address coderabbit review
Jdubrick Jul 27, 2026
fb409d7
regen openapi.json doc
Jdubrick Jul 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
222 changes: 222 additions & 0 deletions docs/devel_doc/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12317,6 +12317,11 @@
"title": "BYOK RAG configuration",
"description": "BYOK RAG configuration. This configuration can be used to reconfigure Llama Stack through its run.yaml configuration file"
},
"vector_store": {
"$ref": "#/components/schemas/VectorStoreConfiguration",
"title": "Vector store configuration",
"description": "Dynamic vector-store provider capacity for runtime POST /v1/vector-stores creates. Not the same as byok_rag (static registered corpora). When providers is non-empty, default_provider is required and must match one of providers[].id. Applied in unified synthesis only."
},
"a2a_state": {
"$ref": "#/components/schemas/A2AStateConfiguration",
"title": "A2A state configuration",
Expand Down Expand Up @@ -13231,6 +13236,67 @@
"title": "DetailModel",
"description": "Nested detail model for error responses."
},
"FaissVectorStoreProvider": {
"properties": {
"id": {
"type": "string",
"minLength": 1,
"title": "Provider ID",
"description": "Llama Stack vector_io provider_id. Surrounding whitespace is stripped before validation and emission."
},
"embedding_model": {
"type": "string",
"minLength": 1,
"title": "Embedding model",
"description": "Embedding model identification used for stores created against this provider."
},
"embedding_dimension": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Embedding dimension",
"description": "Dimensionality of embedding vectors for this provider."
},
"type": {
"type": "string",
"const": "faiss",
"title": "Provider type",
"description": "Product type for this dynamic vector-store provider.",
"default": "faiss"
},
"config": {
"$ref": "#/components/schemas/FaissVectorStoreProviderConfig",
"title": "Storage config",
"description": "FAISS storage settings for this provider."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"embedding_model",
"embedding_dimension",
"config"
],
"title": "FaissVectorStoreProvider",
"description": "Dynamic FAISS vector-store provider (runtime create capacity)."
},
"FaissVectorStoreProviderConfig": {
"properties": {
"path": {
"type": "string",
"minLength": 1,
"title": "DB path",
"description": "On-disk FAISS/SQLite path for this provider."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"path"
],
"title": "FaissVectorStoreProviderConfig",
"description": "Storage config for a FAISS dynamic vector-store provider."
},
"FeedbackCategory": {
"type": "string",
"enum": [
Expand Down Expand Up @@ -16680,6 +16746,120 @@
"title": "PasswordOAuthFlow",
"description": "Defines configuration details for the OAuth 2.0 Resource Owner Password flow."
},
"PgvectorVectorStoreProvider": {
"properties": {
"id": {
"type": "string",
"minLength": 1,
"title": "Provider ID",
"description": "Llama Stack vector_io provider_id. Surrounding whitespace is stripped before validation and emission."
},
"embedding_model": {
"type": "string",
"minLength": 1,
"title": "Embedding model",
"description": "Embedding model identification used for stores created against this provider."
},
"embedding_dimension": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Embedding dimension",
"description": "Dimensionality of embedding vectors for this provider."
},
"type": {
"type": "string",
"const": "pgvector",
"title": "Provider type",
"description": "Product type for this dynamic vector-store provider.",
"default": "pgvector"
},
"config": {
"$ref": "#/components/schemas/PgvectorVectorStoreProviderConfig",
"title": "Storage config",
"description": "pgvector connection settings for this provider."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"embedding_model",
"embedding_dimension",
"config"
],
"title": "PgvectorVectorStoreProvider",
"description": "Dynamic pgvector vector-store provider (runtime create capacity)."
},
"PgvectorVectorStoreProviderConfig": {
"properties": {
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "PostgreSQL host",
"description": "PostgreSQL host. Defaults to ${env.POSTGRES_HOST}."
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "PostgreSQL port",
"description": "PostgreSQL port. Defaults to ${env.POSTGRES_PORT}."
},
"db": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "PostgreSQL database",
"description": "PostgreSQL database name. Defaults to ${env.POSTGRES_DATABASE}."
},
"user": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "PostgreSQL user",
"description": "PostgreSQL user. Defaults to ${env.POSTGRES_USER}."
},
"password": {
"anyOf": [
{
"type": "string",
"format": "password",
"writeOnly": true
},
{
"type": "null"
}
],
"title": "PostgreSQL password",
"description": "PostgreSQL password. Defaults to ${env.POSTGRES_PASSWORD}."
}
},
"additionalProperties": false,
"type": "object",
"title": "PgvectorVectorStoreProviderConfig",
"description": "Storage config for a pgvector dynamic vector-store provider."
},
"PostgreSQLDatabaseConfiguration": {
"properties": {
"host": {
Expand Down Expand Up @@ -20572,6 +20752,48 @@
],
"title": "ValidationError"
},
"VectorStoreConfiguration": {
"properties": {
"default_provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default provider",
"description": "Provider id used for vector_stores.default_* in the synthesized Llama Stack config. Required when providers is non-empty; must match one of providers[].id."
},
"providers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/FaissVectorStoreProvider"
},
{
"$ref": "#/components/schemas/PgvectorVectorStoreProvider"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"faiss": "#/components/schemas/FaissVectorStoreProvider",
"pgvector": "#/components/schemas/PgvectorVectorStoreProvider"
}
}
},
"type": "array",
"title": "Vector store providers",
"description": "Dynamic vector-store provider capacity for runtime POST /v1/vector-stores creates. Not the same as byok_rag (static registered corpora)."
}
},
"additionalProperties": false,
"type": "object",
"title": "VectorStoreConfiguration",
"description": "Configuration for dynamic vector-store providers.\n\nMirrors ``InferenceConfiguration``: a providers list plus a sibling\n``default_provider`` pointer, rather than a per-entry default flag.\n\nAttributes:\n default_provider: Provider id used for vector_stores.default_* in the\n synthesized Llama Stack config. Required when providers is\n non-empty; must match one of providers[].id. Must be omitted when\n providers is empty.\n providers: Dynamic vector-store provider capacity for runtime\n POST /v1/vector-stores creates. Not the same as byok_rag (static\n registered corpora)."
},
"VectorStoreCreateRequest": {
"properties": {
"name": {
Expand Down
2 changes: 2 additions & 0 deletions docs/user_doc/byok_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,8 @@ The BYOK (Bring Your Own Knowledge) feature in Lightspeed Core provides powerful

For additional support and advanced configurations, refer to:
- [RAG Configuration Guide](rag_guide.md)
- [Dynamic vector store providers](rag_guide.md#configure-dynamic-vector-store-providers) (runtime creates)
- [Configuration schema](config.md)
- [rag-content Tool Repository](https://github.com/lightspeed-core/rag-content)

Remember to regularly update your knowledge sources and monitor system performance to maintain optimal BYOK functionality.
Loading
Loading