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/user_guide/python-api.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
3
3
The primary way for using guardrails in your project is:
4
4
5
-
1. Create a [`RailsConfig`](../api/nemoguardrails.rails.llm.config.md#kbdclasskbd-railsconfig) object.
6
-
2. Create an [`LLMRails`](../api/nemoguardrails.rails.llm.llmrails.md#kbdclasskbd-llmrails) instance. The `LLMRails` class is the core class that enforces the configured guardrails.
7
-
3. Generate LLM responses using the [`LLMRails.generate(...)`](../api/nemoguardrails.rails.llm.llmrails.md#kbdmethodkbd-llmrailsgenerate) or [`LLMRails.generate_async(...)`](../api/nemoguardrails.rails.llm.llmrails.md#kbdmethodkbd-llmrailsgenerate_async) methods.
5
+
1. Create a [`RailsConfig`](../api/nemoguardrails.rails.llm.config.md#class-railsconfig) object.
6
+
2. Create an [`LLMRails`](../api/nemoguardrails.rails.llm.llmrails.md#class-llmrails) instance. The `LLMRails` class is the core class that enforces the configured guardrails.
7
+
3. Generate LLM responses using the [`LLMRails.generate(...)`](../api/nemoguardrails.rails.llm.llmrails.md#method-llmrailsgenerate) or [`LLMRails.generate_async(...)`](../api/nemoguardrails.rails.llm.llmrails.md#method-llmrailsgenerate_async) methods.
The [RailsConfig](../api/nemoguardrails.rails.llm.config.md#kbdclasskbd-railsconfig) class contains the key bits of information for configuring guardrails:
25
+
The [RailsConfig](../api/nemoguardrails.rails.llm.config.md#class-railsconfig) class contains the key bits of information for configuring guardrails:
26
26
27
27
-`models`: The list of models used by the rails configuration.
28
28
-`user_messages`: The list of user messages that should be used for the rails.
@@ -35,9 +35,9 @@ The [RailsConfig](../api/nemoguardrails.rails.llm.config.md#kbdclasskbd-railscon
35
35
36
36
## Message Generation
37
37
38
-
To use a guardrails configuration, you can call the [LLMRails.generate](../api/nemoguardrails.rails.llm.llmrails.md#kbdmethodkbd-llmrailsgenerate) or [LLMRails.generate_async](../api/nemoguardrails.rails.llm.llmrails.md#kbdmethodkbd-llmrailsgenerate_async) methods.
38
+
To use a guardrails configuration, you can call the [LLMRails.generate](../api/nemoguardrails.rails.llm.llmrails.md#method-llmrailsgenerate) or [LLMRails.generate_async](../api/nemoguardrails.rails.llm.llmrails.md#method-llmrailsgenerate_async) methods.
39
39
40
-
The [LLMRails.generate](../api/nemoguardrails.rails.llm.llmrails.md#kbdmethodkbd-llmrailsgenerate) method takes as input either a `prompt` or a `messages` array. When a prompt is provided, the guardrails apply as in a single-turn conversation. The structure of a message is the following:
40
+
The [LLMRails.generate](../api/nemoguardrails.rails.llm.llmrails.md#method-llmrailsgenerate) method takes as input either a `prompt` or a `messages` array. When a prompt is provided, the guardrails apply as in a single-turn conversation. The structure of a message is the following:
41
41
42
42
```yaml
43
43
properties:
@@ -101,7 +101,7 @@ For convenience, this toolkit also includes a selection of LangChain tools, wrap
101
101
102
102
### Chains as Actions
103
103
104
-
You can register a Langchain chain as an action using the [LLMRails.register_action](../api/nemoguardrails.rails.llm.llmrails.md#kbdmethodkbd-llmrailsregister_action) method:
104
+
You can register a Langchain chain as an action using the [LLMRails.register_action](../api/nemoguardrails.rails.llm.llmrails.md#method-llmrailsregister_action) method:
0 commit comments