Skip to content

Commit fcd2b86

Browse files
committed
openapi documentation for safety shielf config
Signed-off-by: Lucas <[email protected]>
1 parent a5ed817 commit fcd2b86

File tree

2 files changed

+171
-76
lines changed

2 files changed

+171
-76
lines changed

docs/openapi.json

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6281,6 +6281,11 @@
62816281
"title": "Disable Query System Prompt",
62826282
"default": false
62836283
},
6284+
"disable_shield_ids_override": {
6285+
"type": "boolean",
6286+
"title": "Disable Shield Ids Override",
6287+
"default": false
6288+
},
62846289
"system_prompt_path": {
62856290
"anyOf": [
62866291
{
@@ -7967,6 +7972,25 @@
79677972
"vector_db_1"
79687973
]
79697974
},
7975+
"shield_ids": {
7976+
"anyOf": [
7977+
{
7978+
"items": {
7979+
"type": "string"
7980+
},
7981+
"type": "array"
7982+
},
7983+
{
7984+
"type": "null"
7985+
}
7986+
],
7987+
"title": "Shield Ids",
7988+
"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).",
7989+
"examples": [
7990+
"llama-guard",
7991+
"custom-shield"
7992+
]
7993+
},
79707994
"solr": {
79717995
"anyOf": [
79727996
{
@@ -7995,7 +8019,7 @@
79958019
"query"
79968020
],
79978021
"title": "QueryRequest",
7998-
"description": "Model representing a request for the LLM (Language Model).\n\nAttributes:\n query: The query string.\n conversation_id: The optional conversation ID (UUID).\n provider: The optional provider.\n model: The optional model.\n system_prompt: The optional system prompt.\n attachments: The optional attachments.\n no_tools: Whether to bypass all tools and MCP servers (default: False).\n generate_topic_summary: Whether to generate topic summary for new conversations.\n media_type: The optional media type for response format (application/json or text/plain).\n vector_store_ids: The optional list of specific vector store IDs to query for RAG.\n\nExample:\n ```python\n query_request = QueryRequest(query=\"Tell me about Kubernetes\")\n ```",
8022+
"description": "Model representing a request for the LLM (Language Model).\n\nAttributes:\n query: The query string.\n conversation_id: The optional conversation ID (UUID).\n provider: The optional provider.\n model: The optional model.\n system_prompt: The optional system prompt.\n attachments: The optional attachments.\n no_tools: Whether to bypass all tools and MCP servers (default: False).\n generate_topic_summary: Whether to generate topic summary for new conversations.\n media_type: The optional media type for response format (application/json or text/plain).\n vector_store_ids: The optional list of specific vector store IDs to query for RAG.\n shield_ids: The optional list of safety shield IDs to apply.\n\nExample:\n ```python\n query_request = QueryRequest(query=\"Tell me about Kubernetes\")\n ```",
79998023
"examples": [
80008024
{
80018025
"attachments": [

0 commit comments

Comments
 (0)