Skip to content

Commit bd62934

Browse files
committed
Updated OpenAPI specification
1 parent 0291d01 commit bd62934

1 file changed

Lines changed: 43 additions & 17 deletions

File tree

docs/openapi.md

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3804,6 +3804,7 @@ BYOK (Bring Your Own Knowledge) RAG configuration.
38043804
| embedding_dimension | integer | Dimensionality of embedding vectors. |
38053805
| vector_db_id | string | Vector database identification. |
38063806
| db_path | string | Path to RAG database. |
3807+
| 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. |
38073808

38083809

38093810
## CORSConfiguration
@@ -3868,7 +3869,8 @@ Global service configuration.
38683869
| azure_entra_id | | |
38693870
| splunk | | Splunk HEC configuration for sending telemetry events. |
38703871
| deployment_environment | string | Deployment environment name (e.g., 'development', 'staging', 'production'). Used in telemetry events. |
3871-
| solr | | Configuration for Solr vector search operations. |
3872+
| rag | | Configuration for all RAG strategies (inline and tool-based). |
3873+
| okp | | OKP provider settings. Only used when 'okp' is listed in rag.inline or rag.tool. |
38723874

38733875

38743876
## ConfigurationResponse
@@ -4523,12 +4525,14 @@ Model representing a message in a conversation turn.
45234525
Attributes:
45244526
content: The message content.
45254527
type: The type of message.
4528+
referenced_documents: Optional list of documents referenced in an assistant response.
45264529

45274530

45284531
| Field | Type | Description |
45294532
|-------|------|-------------|
45304533
| content | string | The message content |
45314534
| type | string | The type of message |
4535+
| referenced_documents | | List of documents referenced in the response (assistant messages only) |
45324536

45334537

45344538
## ModelContextProtocolServer
@@ -4622,6 +4626,21 @@ Defines the configuration for the supported OAuth 2.0 flows.
46224626
| password | | |
46234627

46244628

4629+
## OkpConfiguration
4630+
4631+
4632+
OKP (Offline Knowledge Portal) provider configuration.
4633+
4634+
Controls provider-specific behaviour for the OKP vector store.
4635+
Only relevant when ``"okp"`` is listed in ``rag.inline`` or ``rag.tool``.
4636+
4637+
4638+
| Field | Type | Description |
4639+
|-------|------|-------------|
4640+
| offline | boolean | When True, use parent_id for OKP chunk source URLs. When False, use reference_url for chunk source URLs. |
4641+
| chunk_filter_query | string | 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*'. |
4642+
4643+
46254644
## OpenIdConnectSecurityScheme
46264645

46274646

@@ -4769,7 +4788,7 @@ Example:
47694788
| generate_topic_summary | | Whether to generate topic summary for new conversations |
47704789
| media_type | | Media type for the response format |
47714790
| vector_store_ids | | Optional list of specific vector store IDs to query for RAG. If not provided, all available vector stores will be queried. |
4772-
| shield_ids | | Optional list of safety shield IDs to apply. If None, all configured shields are used. If provided, must contain at least one valid shield ID (empty list raises 422 error). |
4791+
| shield_ids | | Optional list of safety shield IDs to apply. If None, all configured shields are used. |
47734792
| solr | | Solr-specific query parameters including filter queries |
47744793

47754794

@@ -4938,6 +4957,28 @@ Red Hat Identity authentication configuration.
49384957
| required_entitlements | | List of all required entitlements. |
49394958

49404959

4960+
## RagConfiguration
4961+
4962+
4963+
RAG strategy configuration.
4964+
4965+
Controls which RAG sources are used for inline and tool-based retrieval.
4966+
4967+
Each strategy lists RAG IDs to include. The special ID ``"okp"`` defined in constants,
4968+
activates the OKP provider; all other IDs refer to entries in ``byok_rag``.
4969+
4970+
Backward compatibility:
4971+
- ``inline`` defaults to ``[]`` (no inline RAG).
4972+
- ``tool`` defaults to ``None`` which means all registered vector stores
4973+
are used (identical to the previous ``tool.byok.enabled = True`` default).
4974+
4975+
4976+
| Field | Type | Description |
4977+
|-------|------|-------------|
4978+
| inline | array | 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). |
4979+
| tool | | 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). |
4980+
4981+
49414982
## ReadinessResponse
49424983

49434984

@@ -5200,21 +5241,6 @@ Model representing a response to shields request.
52005241
| shields | array | List of shields available |
52015242

52025243

5203-
## SolrConfiguration
5204-
5205-
5206-
Solr configuration for vector search queries.
5207-
5208-
Controls whether to use offline or online mode when building document URLs
5209-
from vector search results, and enables/disables Solr vector IO functionality.
5210-
5211-
5212-
| Field | Type | Description |
5213-
|-------|------|-------------|
5214-
| enabled | boolean | When True, enables Solr vector IO functionality for vector search queries. When False, disables Solr vector search processing. |
5215-
| offline | boolean | When True, use parent_id for chunk source URLs. When False, use reference_url for chunk source URLs. |
5216-
5217-
52185244
## SplunkConfiguration
52195245

52205246

0 commit comments

Comments
 (0)