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: README.md
+1-6
Original file line number
Diff line number
Diff line change
@@ -46,11 +46,6 @@ console.log(response);
46
46
## Caveats and Oddities
47
47
The current version of the library uses a IO bridge so both javascript and python3 must be available in the environment.
48
48
49
-
The bridge implementation we use doesn't always work well with multi-processing. For this reason it is best to set the `GUARDRAILS_PROCESS_COUNT` environment variable to `1` when starting the node process:
For the best experience, you may also need to explicitly call for the bridge to exit at the end of the node process. We export an `exit` function to serve this purpose.
Copy file name to clipboardExpand all lines: docs/README.md
+6-11
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
guardrails-ai / [Exports](modules.md)
1
+
@guardrails-ai/core / [Exports](modules.md)
2
2
3
3
# guardrails-js
4
4
A Javascript wrapper for guardrails-ai.
@@ -18,18 +18,18 @@ The key differences between this wrapper and the python library are as follows:
18
18
1. No support for re-asking (though you can perform reasks yourself outside of the library using `ValidationOutcome.reask` or `guard.history.at(#).reask_prompts` when defined)
19
19
1. LLM calls must be made by the user and the text response passed into parse
20
20
21
-
In addition to above, this library also supports the readonly properties on the [ValidationOutcome class](https://www.guardrailsai.com/docs/api_reference_markdown/validation_outcome) as well as readonly versions of the History & Logs related classes like [Call](https://www.guardrailsai.com/docs/api_reference_markdown/history_and_logs#call-objects), [Iteration](https://www.guardrailsai.com/docs/api_reference_markdown/history_and_logs#iteration-objects), etc..
21
+
In addition to above, this library also supports the readonly properties on the [ValidationOutcome class](https://www.guardrailsai.com/docs/hub/api_reference_markdown/validation_outcome) as well as readonly versions of the History & Logs related classes like [Call](https://www.guardrailsai.com/docs/api_reference_markdown/history_and_logs#call-objects), [Iteration](https://www.guardrailsai.com/docs/api_reference_markdown/history_and_logs#iteration-objects), etc..
22
22
23
23
See the JS docs [here](/docs/modules.md)
24
24
25
25
## Installation
26
26
```sh
27
-
npm i git+https://github.com/guardrails-ai/guardrails-js.git
The current version of the library uses a IO bridge so both javascript and python3 must be available in the environment.
50
50
51
-
The bridge implementation we use doesn't always work well with multi-processing. For this reason it is best to set the `GUARDRAILS_PROCESS_COUNT` environment variable to `1` when starting the node process:
For the best experience, you may also need to explicitly call for the bridge to exit at the end of the node process. We export an `exit` function to serve this purpose.
57
52
58
53
Below is a simple end-to-end test we use that demonstrates the concepts above:
0 commit comments