Skip to content

Commit 1b3d0c1

Browse files
Update README.md
1 parent 4dd6e96 commit 1b3d0c1

File tree

1 file changed

+7
-13
lines changed

1 file changed

+7
-13
lines changed

README.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,19 @@ If bundler is not being used to manage dependencies, install the gem by executin
2525

2626
gem install langchainrb_rails
2727

28-
## Usage
28+
## Rails Generators
2929

30-
```ruby
31-
require "langchainrb_rails"
32-
```
33-
34-
## Generators
35-
36-
### Vectorsearch
30+
### Pinecone Generator - adds vectorsearch to your ActiveRecord model
3731

38-
#### Pinecone Generator
39-
40-
Command: `rails generate langchainrb_rails:pinecone --model=Product --llm=openai`
32+
```
33+
rails generate langchainrb_rails:pinecone --model=Product --llm=openai
34+
```
4135

4236
Available `--llm` options: `cohere`, `google_palm`, `hugging_face`, `llama_cpp`, `ollama`, `openai`, and `replicate`. The selected LLM will be used to generate embeddings and completions.
4337

4438
The `--model` option is used to specify which ActiveRecord model vectorsearch capabilities will be added to.
4539

46-
PineconeGenerator does the following:
47-
1. Creates the `langchainrb_rails.rb` initializer file
40+
Pinecone Generator does the following:
41+
1. Creates the `config/initializers/langchainrb_rails.rb` initializer file
4842
2. Adds necessary code to the ActiveRecord model to enable vectorsearch
4943
3. Adds `pinecone` gem to the Gemfile

0 commit comments

Comments
 (0)