Skip to content

Commit 73eeab0

Browse files
committed
Fix anchor references in the python API user guide.
1 parent cda6f13 commit 73eeab0

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/user_guide/python-api.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
The primary way for using guardrails in your project is:
44

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.
88

99
## Basic usage
1010

@@ -22,7 +22,7 @@ new_message = app.generate(messages=[{
2222

2323
## RailsConfig
2424

25-
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:
2626

2727
- `models`: The list of models used by the rails configuration.
2828
- `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
3535

3636
## Message Generation
3737

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.
3939

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:
4141

4242
```yaml
4343
properties:
@@ -101,7 +101,7 @@ For convenience, this toolkit also includes a selection of LangChain tools, wrap
101101

102102
### Chains as Actions
103103

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:
105105

106106
```python
107107
app.register_action(some_chain, name="some_chain")

0 commit comments

Comments
 (0)