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   "name": "",
11   "project": "string",
12   "description": "string",
13   "data": {
14     "models": [
15       {
16         "type": "string",
17         "engine": "string",
18         "model": "string",
19         "parameters": {
20           "base_url": "string",
21           "default_headers": {}
22         },
23         "mode": "chat",
24         "cache": {
25           "enabled": false,
26           "maxsize": 50000,
27           "stats": {
28             "enabled": false,
29             "log_interval": 1.1
30           }
31         }
32       }
33     ],
34     "instructions": [
35       {
36         "type": "string",
37         "content": "string"
38       }
39     ],
40     "actions_server_url": "string",
41     "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",
42     "prompts": [
43       {
44         "task": "string",
45         "content": "string",
46         "messages": [
47           {
48             "type": "string",
49             "content": "string"
50           }
51         ],
52         "models": [
53           "string"
54         ],
55         "output_parser": "string",
56         "max_length": 16000,
57         "mode": "standard",
58         "stop": [
59           "string"
60         ],
61         "max_tokens": 1
62       }
63     ],
64     "prompting_mode": "standard",
65     "lowest_temperature": 0.001,
66     "enable_multi_step_generation": false,
67     "colang_version": "1.0",
68     "custom_data": {},
69     "rails": {
70       "config": {
71         "fact_checking": {
72           "parameters": {},
73           "fallback_to_self_check": false
74         },
75         "autoalign": {
76           "parameters": {},
77           "input": {
78             "guardrails_config": {}
79           },
80           "output": {
81             "guardrails_config": {}
82           }
83         },
84         "patronus": {
85           "input": {
86             "evaluate_config": {
87               "success_strategy": "all_pass",
88               "params": {}
89             }
90           },
91           "output": {
92             "evaluate_config": {
93               "success_strategy": "all_pass",
94               "params": {}
95             }
96           }
97         },
98         "sensitive_data_detection": {
99           "recognizers": [
100             {}
101           ],
102           "input": {
103             "entities": [
104               "string"
105             ],
106             "mask_token": "*",
107             "score_threshold": 0.2
108           },
109           "output": {
110             "entities": [
111               "string"
112             ],
113             "mask_token": "*",
114             "score_threshold": 0.2
115           },
116           "retrieval": {
117             "entities": [
118               "string"
119             ],
120             "mask_token": "*",
121             "score_threshold": 0.2
122           }
123         },
124         "regex_detection": {
125           "input": {
126             "patterns": [
127               "string"
128             ],
129             "case_insensitive": false
130           },
131           "output": {
132             "patterns": [
133               "string"
134             ],
135             "case_insensitive": false
136           },
137           "retrieval": {
138             "patterns": [
139               "string"
140             ],
141             "case_insensitive": false
142           }
143         },
144         "jailbreak_detection": {
145           "server_endpoint": "string",
146           "length_per_perplexity_threshold": 89.79,
147           "prefix_suffix_perplexity_threshold": 1845.65,
148           "nim_base_url": "string",
149           "nim_server_endpoint": "classify",
150           "api_key_env_var": "string",
151           "nim_url": "string",
152           "nim_port": 1,
153           "embedding": "string"
154         },
155         "injection_detection": {
156           "injections": [
157             "string"
158           ],
159           "action": "reject",
160           "yara_rules": {}
161         },
162         "privateai": {
163           "server_endpoint": "string",
164           "input": {
165             "entities": [
166               "string"
167             ]
168           },
169           "output": {
170             "entities": [
171               "string"
172             ]
173           },
174           "retrieval": {
175             "entities": [
176               "string"
177             ]
178           }
179         },
180         "gliner": {
181           "server_endpoint": "http://localhost:1235/v1/extract",
182           "threshold": 0.5,
183           "chunk_length": 384,
184           "overlap": 128,
185           "flat_ner": false,
186           "input": {
187             "entities": [
188               "string"
189             ]
190           },
191           "output": {
192             "entities": [
193               "string"
194             ]
195           },
196           "retrieval": {
197             "entities": [
198               "string"
199             ]
200           }
201         },
202         "fiddler": {
203           "fiddler_endpoint": "http://localhost:8080/process/text",
204           "safety_threshold": 0.1,
205           "faithfulness_threshold": 0.05
206         },
207         "clavata": {
208           "server_endpoint": "https://gateway.app.clavata.ai:8443",
209           "policies": {},
210           "label_match_logic": "ANY",
211           "input": {
212             "policy": "string",
213             "labels": [
214               "string"
215             ]
216           },
217           "output": {
218             "policy": "string",
219             "labels": [
220               "string"
221             ]
222           }
223         },
224         "crowdstrike_aidr": {
225           "timeout": 30
226         },
227         "pangea": {
228           "input": {
229             "recipe": "string"
230           },
231           "output": {
232             "recipe": "string"
233           }
234         },
235         "guardrails_ai": {
236           "validators": [
237             {
238               "name": "string",
239               "parameters": {},
240               "metadata": {}
241             }
242           ]
243         },
244         "trend_micro": {
245           "v1_url": "https://api.xdr.trendmicro.com/v3.0/aiSecurity/applyGuardrails",
246           "api_key_env_var": "string",
247           "application_name": "nemo-guardrails",
248           "detailed_response": false
249         },
250         "ai_defense": {
251           "timeout": 30,
252           "fail_open": false
253         },
254         "content_safety": {
255           "multilingual": {
256             "enabled": false,
257             "refusal_messages": {}
258           },
259           "reasoning": {
260             "enabled": false
261           }
262         }
263       },
264       "input": {
265         "parallel": false,
266         "flows": [
267           "string"
268         ]
269       },
270       "output": {
271         "parallel": false,
272         "flows": [
273           "string"
274         ],
275         "streaming": {
276           "enabled": true,
277           "chunk_size": 200,
278           "context_size": 50,
279           "stream_first": true
280         },
281         "apply_to_reasoning_traces": false
282       },
283       "retrieval": {
284         "flows": [
285           "string"
286         ]
287       },
288       "dialog": {
289         "single_call": {
290           "enabled": false,
291           "fallback_to_multiple_calls": true
292         },
293         "user_messages": {
294           "embeddings_only": false,
295           "embeddings_only_similarity_threshold": 0.5,
296           "embeddings_only_fallback_intent": "string"
297         }
298       },
299       "actions": {
300         "instant_actions": [
301           "string"
302         ]
303       },
304       "tool_output": {
305         "flows": [
306           "string"
307         ],
308         "parallel": false
309       },
310       "tool_input": {
311         "flows": [
312           "string"
313         ],
314         "parallel": false
315       }
316     },
317     "enable_rails_exceptions": false,
318     "passthrough": true,
319     "tracing": {
320       "enabled": false,
321       "adapters": [
322         {
323           "name": "FileSystem"
324         }
325       ],
326       "span_format": "opentelemetry",
327       "enable_content_capture": false
328     }
329   }
330 }

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.

namestringDefaults to

Entity name within the workspace

projectstring

The name of the project associated with this entity.

descriptionstring

Description of the guardrail config

dataobject

Guardrail configuration data

Errors

404

Not Found Error

422

Unprocessable Entity Error