You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/openapi.json
+23-16Lines changed: 23 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -5500,7 +5500,6 @@
5500
5500
},
5501
5501
"db_path": {
5502
5502
"type": "string",
5503
-
"format": "file-path",
5504
5503
"title": "DB path",
5505
5504
"description": "Path to RAG database."
5506
5505
},
@@ -7312,6 +7311,21 @@
7312
7311
"system",
7313
7312
"developer"
7314
7313
]
7314
+
},
7315
+
"referenced_documents": {
7316
+
"anyOf": [
7317
+
{
7318
+
"items": {
7319
+
"$ref": "#/components/schemas/ReferencedDocument"
7320
+
},
7321
+
"type": "array"
7322
+
},
7323
+
{
7324
+
"type": "null"
7325
+
}
7326
+
],
7327
+
"title": "Referenced Documents",
7328
+
"description": "List of documents referenced in the response (assistant messages only)"
7315
7329
}
7316
7330
},
7317
7331
"type": "object",
@@ -7320,7 +7334,7 @@
7320
7334
"type"
7321
7335
],
7322
7336
"title": "Message",
7323
-
"description": "Model representing a message in a conversation turn.\n\nAttributes:\n content: The message content.\n type: The type of message."
7337
+
"description": "Model representing a message in a conversation turn.\n\nAttributes:\n content: The message content.\n type: The type of message.\n referenced_documents: Optional list of documents referenced in an assistant response."
7324
7338
},
7325
7339
"ModelContextProtocolServer": {
7326
7340
"properties": {
@@ -8140,7 +8154,7 @@
8140
8154
}
8141
8155
],
8142
8156
"title": "Shield Ids",
8143
-
"description": "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).",
8157
+
"description": "Optional list of safety shield IDs to apply. If None, all configured shields are used. ",
8144
8158
"examples": [
8145
8159
"llama-guard",
8146
8160
"custom-shield"
@@ -8785,25 +8799,18 @@
8785
8799
"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)."
8786
8800
},
8787
8801
"tool": {
8788
-
"anyOf": [
8789
-
{
8790
-
"items": {
8791
-
"type": "string"
8792
-
},
8793
-
"type": "array"
8794
-
},
8795
-
{
8796
-
"type": "null"
8797
-
}
8798
-
],
8802
+
"items": {
8803
+
"type": "string"
8804
+
},
8805
+
"type": "array",
8799
8806
"title": "Tool RAG IDs",
8800
8807
"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)."
8801
8808
}
8802
8809
},
8803
8810
"additionalProperties": false,
8804
8811
"type": "object",
8805
8812
"title": "RagConfiguration",
8806
-
"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 ``None`` which means all registered vector stores\n are used (identical to the previous ``tool.byok.enabled = True`` default)."
8813
+
"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."
0 commit comments