Get Guardrail Config

GET

https://host.com/apis/guardrails/v2/workspaces/:workspace/configs/:name

GET

/apis/guardrails/v2/workspaces/:workspace/configs/:name

$ curl https://host.com/apis/guardrails/v2/workspaces/workspace/configs/name

1 {
2   "workspace": "string",
3   "id": "string",
4   "created_at": "2024-01-15T09:30:00Z",
5   "created_by": "string",
6   "updated_at": "2024-01-15T09:30:00Z",
7   "updated_by": "string",
8   "entity_id": "string",
9   "parent": "string",
10   "db_version": 1,
11   "name": "",
12   "project": "string",
13   "description": "string",
14   "data": {
15     "models": [
16       {
17         "type": "string",
18         "engine": "string",
19         "model": "string",
20         "parameters": {
21           "base_url": "string",
22           "default_headers": {}
23         },
24         "mode": "chat",
25         "cache": {
26           "enabled": false,
27           "maxsize": 50000,
28           "stats": {
29             "enabled": false,
30             "log_interval": 1.1
31           }
32         }
33       }
34     ],
35     "instructions": [
36       {
37         "type": "string",
38         "content": "string"
39       }
40     ],
41     "actions_server_url": "string",
42     "sample_conversation": "user \"Hello there!\"\n  express greeting\nbot express greeting\n  \"Hello! How can I assist you today?\"\nuser \"What can you do for me?\"\n  ask about capabilities\nbot respond about capabilities\n  \"As an AI assistant, I can help you with a wide range of tasks. This includes question answering on various topics, generating text for various purposes and providing suggestions based on your preferences.\"\nuser \"Tell me a bit about the history of NVIDIA.\"\n  ask general question\nbot response for general question\n  \"NVIDIA is a technology company that specializes in designing and manufacturing graphics processing units (GPUs) and other computer hardware. The company was founded in 1993 by Jen-Hsun Huang, Chris Malachowsky, and Curtis Priem.\"\nuser \"tell me more\"\n  request more information\nbot provide more information\n  \"Initially, the company focused on developing 3D graphics processing technology for the PC gaming market. In 1999, NVIDIA released the GeForce 256, the world's first GPU, which was a major breakthrough for the gaming industry. The company continued to innovate in the GPU space, releasing new products and expanding into other markets such as professional graphics, mobile devices, and artificial intelligence.\"\nuser \"thanks\"\n  express appreciation\nbot express appreciation and offer additional help\n  \"You're welcome. If you have any more questions or if there's anything else I can help you with, please don't hesitate to ask.\"\n",
43     "prompts": [
44       {
45         "task": "string",
46         "content": "string",
47         "messages": [
48           {
49             "type": "string",
50             "content": "string"
51           }
52         ],
53         "models": [
54           "string"
55         ],
56         "output_parser": "string",
57         "max_length": 16000,
58         "mode": "standard",
59         "stop": [
60           "string"
61         ],
62         "max_tokens": 1
63       }
64     ],
65     "prompting_mode": "standard",
66     "lowest_temperature": 0.001,
67     "enable_multi_step_generation": false,
68     "colang_version": "1.0",
69     "custom_data": {},
70     "rails": {
71       "config": {
72         "fact_checking": {
73           "parameters": {},
74           "fallback_to_self_check": false
75         },
76         "autoalign": {
77           "parameters": {},
78           "input": {
79             "guardrails_config": {}
80           },
81           "output": {
82             "guardrails_config": {}
83           }
84         },
85         "patronus": {
86           "input": {
87             "evaluate_config": {
88               "success_strategy": "all_pass",
89               "params": {}
90             }
91           },
92           "output": {
93             "evaluate_config": {
94               "success_strategy": "all_pass",
95               "params": {}
96             }
97           }
98         },
99         "sensitive_data_detection": {
100           "recognizers": [
101             {}
102           ],
103           "input": {
104             "entities": [
105               "string"
106             ],
107             "mask_token": "*",
108             "score_threshold": 0.2
109           },
110           "output": {
111             "entities": [
112               "string"
113             ],
114             "mask_token": "*",
115             "score_threshold": 0.2
116           },
117           "retrieval": {
118             "entities": [
119               "string"
120             ],
121             "mask_token": "*",
122             "score_threshold": 0.2
123           }
124         },
125         "regex_detection": {
126           "input": {
127             "patterns": [
128               "string"
129             ],
130             "case_insensitive": false
131           },
132           "output": {
133             "patterns": [
134               "string"
135             ],
136             "case_insensitive": false
137           },
138           "retrieval": {
139             "patterns": [
140               "string"
141             ],
142             "case_insensitive": false
143           }
144         },
145         "jailbreak_detection": {
146           "server_endpoint": "string",
147           "length_per_perplexity_threshold": 89.79,
148           "prefix_suffix_perplexity_threshold": 1845.65,
149           "nim_base_url": "string",
150           "nim_server_endpoint": "classify",
151           "api_key_env_var": "string",
152           "nim_url": "string",
153           "nim_port": 1,
154           "embedding": "string"
155         },
156         "injection_detection": {
157           "injections": [
158             "string"
159           ],
160           "action": "reject",
161           "yara_rules": {}
162         },
163         "privateai": {
164           "server_endpoint": "string",
165           "input": {
166             "entities": [
167               "string"
168             ]
169           },
170           "output": {
171             "entities": [
172               "string"
173             ]
174           },
175           "retrieval": {
176             "entities": [
177               "string"
178             ]
179           }
180         },
181         "gliner": {
182           "server_endpoint": "http://localhost:8000/v1/chat/completions",
183           "model": "nvidia/gliner-pii",
184           "api_key_env_var": "string",
185           "threshold": 0.5,
186           "chunk_length": 384,
187           "overlap": 128,
188           "flat_ner": false,
189           "input": {
190             "entities": [
191               "string"
192             ]
193           },
194           "output": {
195             "entities": [
196               "string"
197             ]
198           },
199           "retrieval": {
200             "entities": [
201               "string"
202             ]
203           }
204         },
205         "polygraf": {
206           "server_endpoint": "http://localhost:8000/v1/pii/text-detect",
207           "input": {
208             "entities": [
209               "string"
210             ]
211           },
212           "output": {
213             "entities": [
214               "string"
215             ]
216           },
217           "retrieval": {
218             "entities": [
219               "string"
220             ]
221           }
222         },
223         "fiddler": {
224           "fiddler_endpoint": "http://localhost:8080/process/text",
225           "safety_threshold": 0.1,
226           "faithfulness_threshold": 0.05
227         },
228         "clavata": {
229           "server_endpoint": "https://gateway.app.clavata.ai:8443",
230           "policies": {},
231           "label_match_logic": "ANY",
232           "input": {
233             "policy": "string",
234             "labels": [
235               "string"
236             ]
237           },
238           "output": {
239             "policy": "string",
240             "labels": [
241               "string"
242             ]
243           }
244         },
245         "crowdstrike_aidr": {
246           "timeout": 30
247         },
248         "pangea": {
249           "input": {
250             "recipe": "string"
251           },
252           "output": {
253             "recipe": "string"
254           }
255         },
256         "guardrails_ai": {
257           "validators": [
258             {
259               "name": "string",
260               "parameters": {},
261               "metadata": {}
262             }
263           ]
264         },
265         "trend_micro": {
266           "v1_url": "https://api.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails",
267           "api_key_env_var": "string",
268           "application_name": "nemo-guardrails",
269           "detailed_response": false
270         },
271         "ai_defense": {
272           "timeout": 30,
273           "fail_open": false
274         },
275         "content_safety": {
276           "multilingual": {
277             "enabled": false,
278             "refusal_messages": {}
279           },
280           "reasoning": {
281             "enabled": false
282           }
283         },
284         "hf_classifier": {},
285         "context_bloat_detection": {
286           "max_chars": 5000,
287           "min_chars": 50,
288           "min_entropy": 3.5,
289           "max_repetition_ratio": 0.4,
290           "ngram_size": 3,
291           "max_run_ratio": 0.1,
292           "action": "reject"
293         }
294       },
295       "input": {
296         "parallel": false,
297         "flows": [
298           "string"
299         ]
300       },
301       "output": {
302         "parallel": false,
303         "flows": [
304           "string"
305         ],
306         "streaming": {
307           "enabled": true,
308           "chunk_size": 200,
309           "context_size": 50,
310           "stream_first": true
311         },
312         "apply_to_reasoning_traces": false
313       },
314       "retrieval": {
315         "flows": [
316           "string"
317         ]
318       },
319       "dialog": {
320         "single_call": {
321           "enabled": false,
322           "fallback_to_multiple_calls": true
323         },
324         "user_messages": {
325           "embeddings_only": false,
326           "embeddings_only_similarity_threshold": 0.5,
327           "embeddings_only_fallback_intent": "string"
328         }
329       },
330       "actions": {
331         "instant_actions": [
332           "string"
333         ]
334       },
335       "tool_output": {
336         "flows": [
337           "string"
338         ],
339         "parallel": false
340       },
341       "tool_input": {
342         "flows": [
343           "string"
344         ],
345         "parallel": false
346       }
347     },
348     "enable_rails_exceptions": false,
349     "passthrough": true,
350     "tracing": {
351       "enabled": false,
352       "adapters": [
353         {
354           "name": "FileSystem"
355         }
356       ],
357       "span_format": "opentelemetry",
358       "enable_content_capture": false
359     }
360   }
361 }

Get info about a guardrail configuration.

Path parameters

workspacestringRequired

namestringRequired

Response

Successful Response

workspacestringformat: "^[\w\-\+.@:]+$"

Workspace identifier

idstringRead-only

created_atdatetimeRead-only

created_bystring or nullRead-only

updated_atdatetimeRead-only

updated_bystring or nullRead-only

entity_idstringRead-only

Alias for id for backwards compatibility.

parentstringRead-only

Parent entity ID for nested entities.

db_versionintegerRead-only

Database version of the entity for optimistic locking.

namestringOptionalDefaults to

Entity name within the workspace

projectstringOptional

The name of the project associated with this entity.

descriptionstringOptional

Description of the guardrail config

dataobjectOptional

Guardrail configuration data

Errors

404

Not Found Error

422

Unprocessable Entity Error