README.md in langchainrb_rails-0.1.1 vs README.md in langchainrb_rails-0.1.2

- old
+ new

@@ -2,12 +2,10 @@ --- ⚡ Building applications with LLMs through composability ⚡ 👨‍💻👩‍💻 CURRENTLY SEEKING PEOPLE TO FORM THE CORE GROUP OF MAINTAINERS WITH -:warning: UNDER ACTIVE AND RAPID DEVELOPMENT (MAY BE BUGGY AND UNTESTED) - ![Tests status](https://github.com/andreibondarev/langchainrb_rails/actions/workflows/ci.yml/badge.svg?branch=main) [![Gem Version](https://badge.fury.io/rb/langchainrb_rails.svg)](https://badge.fury.io/rb/langchainrb_rails) [![Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/gems/langchainrb_rails) [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/andreibondarev/langchainrb_rails/blob/main/LICENSE.txt) [![](https://dcbadge.vercel.app/api/server/WDARp7J2n8?compact=true&style=flat)](https://discord.gg/WDARp7J2n8) @@ -23,10 +21,21 @@ If bundler is not being used to manage dependencies, install the gem by executing: gem install langchainrb_rails -## Usage +## Rails Generators -```ruby -require "langchainrb_rails" +### Pinecone Generator - adds vectorsearch to your ActiveRecord model + ``` +rails generate langchainrb_rails:pinecone --model=Product --llm=openai +``` + +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. + +The `--model` option is used to specify which ActiveRecord model vectorsearch capabilities will be added to. + +Pinecone Generator does the following: +1. Creates the `config/initializers/langchainrb_rails.rb` initializer file +2. Adds necessary code to the ActiveRecord model to enable vectorsearch +3. Adds `pinecone` gem to the Gemfile