-
-
Notifications
You must be signed in to change notification settings - Fork 218
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f579f3a
commit 94ba8c5
Showing
30 changed files
with
1,287 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: Tests | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- "*" | ||
push: | ||
branches: | ||
- master | ||
jobs: | ||
tests: | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
ruby: ["2.7", "3.0", "3.1", "3.2"] | ||
|
||
steps: | ||
- uses: actions/checkout@master | ||
|
||
- name: Set up Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: ${{ matrix.ruby }} | ||
bundler: default | ||
bundler-cache: true | ||
|
||
- name: StandardRb check | ||
run: bundle exec standardrb | ||
|
||
- name: Run tests | ||
run: | | ||
bundle exec rspec |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
/.bundle/ | ||
/.yardoc | ||
/_yardoc/ | ||
/coverage/ | ||
/doc/ | ||
/pkg/ | ||
/spec/reports/ | ||
/tmp/ | ||
|
||
# rspec failure tracking | ||
.rspec_status | ||
|
||
.env |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
--format documentation | ||
--color | ||
--require spec_helper |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
## [Unreleased] | ||
|
||
## [0.1.0] - 2023-04-26 | ||
|
||
- Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# frozen_string_literal: true | ||
|
||
source "https://rubygems.org" | ||
|
||
# Specify your gem's dependencies in langchain.gemspec | ||
gemspec | ||
|
||
gem "rake", "~> 13.0" | ||
|
||
gem "rspec", "~> 3.0" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,179 @@ | ||
PATH | ||
remote: . | ||
specs: | ||
langchainrb (0.1.3) | ||
cohere-ruby (~> 0.9.1) | ||
milvus (~> 0.9.0) | ||
pinecone (~> 0.1.6) | ||
qdrant-ruby (~> 0.9.0) | ||
ruby-openai (~> 4.0.0) | ||
weaviate-ruby (~> 0.8.0) | ||
|
||
GEM | ||
remote: https://rubygems.org/ | ||
specs: | ||
actionpack (7.0.4.3) | ||
actionview (= 7.0.4.3) | ||
activesupport (= 7.0.4.3) | ||
rack (~> 2.0, >= 2.2.0) | ||
rack-test (>= 0.6.3) | ||
rails-dom-testing (~> 2.0) | ||
rails-html-sanitizer (~> 1.0, >= 1.2.0) | ||
actionview (7.0.4.3) | ||
activesupport (= 7.0.4.3) | ||
builder (~> 3.1) | ||
erubi (~> 1.4) | ||
rails-dom-testing (~> 2.0) | ||
rails-html-sanitizer (~> 1.1, >= 1.2.0) | ||
activesupport (7.0.4.3) | ||
concurrent-ruby (~> 1.0, >= 1.0.2) | ||
i18n (>= 1.6, < 2) | ||
minitest (>= 5.1) | ||
tzinfo (~> 2.0) | ||
builder (3.2.4) | ||
byebug (11.1.3) | ||
coderay (1.1.3) | ||
cohere-ruby (0.9.1) | ||
faraday (~> 2.7.0) | ||
concurrent-ruby (1.2.2) | ||
crass (1.0.6) | ||
diff-lcs (1.5.0) | ||
dotenv (2.7.6) | ||
dotenv-rails (2.7.6) | ||
dotenv (= 2.7.6) | ||
railties (>= 3.2) | ||
dry-configurable (1.0.1) | ||
dry-core (~> 1.0, < 2) | ||
zeitwerk (~> 2.6) | ||
dry-core (1.0.0) | ||
concurrent-ruby (~> 1.0) | ||
zeitwerk (~> 2.6) | ||
dry-inflector (1.0.0) | ||
dry-initializer (3.1.1) | ||
dry-logic (1.5.0) | ||
concurrent-ruby (~> 1.0) | ||
dry-core (~> 1.0, < 2) | ||
zeitwerk (~> 2.6) | ||
dry-schema (1.13.1) | ||
concurrent-ruby (~> 1.0) | ||
dry-configurable (~> 1.0, >= 1.0.1) | ||
dry-core (~> 1.0, < 2) | ||
dry-initializer (~> 3.0) | ||
dry-logic (>= 1.4, < 2) | ||
dry-types (>= 1.7, < 2) | ||
zeitwerk (~> 2.6) | ||
dry-struct (1.6.0) | ||
dry-core (~> 1.0, < 2) | ||
dry-types (>= 1.7, < 2) | ||
ice_nine (~> 0.11) | ||
zeitwerk (~> 2.6) | ||
dry-types (1.7.1) | ||
concurrent-ruby (~> 1.0) | ||
dry-core (~> 1.0) | ||
dry-inflector (~> 1.0) | ||
dry-logic (~> 1.4) | ||
zeitwerk (~> 2.6) | ||
dry-validation (1.10.0) | ||
concurrent-ruby (~> 1.0) | ||
dry-core (~> 1.0, < 2) | ||
dry-initializer (~> 3.0) | ||
dry-schema (>= 1.12, < 2) | ||
zeitwerk (~> 2.6) | ||
erubi (1.12.0) | ||
faraday (2.7.4) | ||
faraday-net_http (>= 2.0, < 3.1) | ||
ruby2_keywords (>= 0.0.4) | ||
faraday-multipart (1.0.4) | ||
multipart-post (~> 2) | ||
faraday-net_http (3.0.2) | ||
graphlient (0.7.0) | ||
faraday (~> 2.0) | ||
graphql-client | ||
graphql (2.0.21) | ||
graphql-client (0.18.0) | ||
activesupport (>= 3.0) | ||
graphql | ||
httparty (0.21.0) | ||
mini_mime (>= 1.0.0) | ||
multi_xml (>= 0.5.2) | ||
i18n (1.13.0) | ||
concurrent-ruby (~> 1.0) | ||
ice_nine (0.11.2) | ||
loofah (2.20.0) | ||
crass (~> 1.0.2) | ||
nokogiri (>= 1.5.9) | ||
method_source (1.0.0) | ||
milvus (0.9.0) | ||
faraday (~> 2.7.0) | ||
mini_mime (1.1.2) | ||
minitest (5.18.0) | ||
multi_xml (0.6.0) | ||
multipart-post (2.3.0) | ||
nokogiri (1.14.3-x86_64-darwin) | ||
racc (~> 1.4) | ||
pinecone (0.1.71) | ||
dry-struct (~> 1.6.0) | ||
dry-validation (~> 1.10.0) | ||
httparty (~> 0.21.0) | ||
pry (0.14.2) | ||
coderay (~> 1.1) | ||
method_source (~> 1.0) | ||
pry-byebug (3.10.1) | ||
byebug (~> 11.0) | ||
pry (>= 0.13, < 0.15) | ||
qdrant-ruby (0.9.0) | ||
faraday (~> 2.7) | ||
racc (1.6.2) | ||
rack (2.2.7) | ||
rack-test (2.1.0) | ||
rack (>= 1.3) | ||
rails-dom-testing (2.0.3) | ||
activesupport (>= 4.2.0) | ||
nokogiri (>= 1.6) | ||
rails-html-sanitizer (1.5.0) | ||
loofah (~> 2.19, >= 2.19.1) | ||
railties (7.0.4.3) | ||
actionpack (= 7.0.4.3) | ||
activesupport (= 7.0.4.3) | ||
method_source | ||
rake (>= 12.2) | ||
thor (~> 1.0) | ||
zeitwerk (~> 2.5) | ||
rake (13.0.6) | ||
rspec (3.12.0) | ||
rspec-core (~> 3.12.0) | ||
rspec-expectations (~> 3.12.0) | ||
rspec-mocks (~> 3.12.0) | ||
rspec-core (3.12.2) | ||
rspec-support (~> 3.12.0) | ||
rspec-expectations (3.12.3) | ||
diff-lcs (>= 1.2.0, < 2.0) | ||
rspec-support (~> 3.12.0) | ||
rspec-mocks (3.12.5) | ||
diff-lcs (>= 1.2.0, < 2.0) | ||
rspec-support (~> 3.12.0) | ||
rspec-support (3.12.0) | ||
ruby-openai (4.0.0) | ||
faraday (>= 1) | ||
faraday-multipart (>= 1) | ||
ruby2_keywords (0.0.5) | ||
thor (1.2.1) | ||
tzinfo (2.0.6) | ||
concurrent-ruby (~> 1.0) | ||
weaviate-ruby (0.8.0) | ||
faraday (~> 2.7) | ||
graphlient (~> 0.7.0) | ||
zeitwerk (2.6.8) | ||
|
||
PLATFORMS | ||
x86_64-darwin-19 | ||
|
||
DEPENDENCIES | ||
dotenv-rails (~> 2.7.6) | ||
langchainrb! | ||
pry-byebug (~> 3.10.0) | ||
rake (~> 13.0) | ||
rspec (~> 3.0) | ||
|
||
BUNDLED WITH | ||
2.4.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2023 Andrei Bondarev | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in | ||
all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
🦜️🔗 LangChain.rb | ||
--- | ||
⚡ Building applications with LLMs through composability ⚡ | ||
|
||
:warning: UNDER ACTIVE AND RAPID DEVELOPMENT (MAY BE BUGGY AND UNTESTED) | ||
|
||
![Tests status](https://github.com/andreibondarev/langchainrb/actions/workflows/ci.yml/badge.svg) [![Gem Version](https://badge.fury.io/rb/langchainrb.svg)](https://badge.fury.io/rb/langchainrb) | ||
|
||
Vectorsearch library is an abstraction layer on top of many popular vector search databases. It is a modern ORM that allows developers to easily chunk data, generate embeddings, store, search, query and retrieve data from vector search databases. Vectorsearch offers a straight-forward DSL and abstracts away overly complicated machine learning/data science-specific configurations and concepts | ||
|
||
## Installation | ||
|
||
Install the gem and add to the application's Gemfile by executing: | ||
|
||
$ bundle add langchainrb | ||
|
||
If bundler is not being used to manage dependencies, install the gem by executing: | ||
|
||
$ gem install langchainrb | ||
|
||
## Usage | ||
|
||
```ruby | ||
require "langchain" | ||
``` | ||
|
||
List of currently supported vector search databases and features: | ||
|
||
| Database | Querying | Storage | Schema Management | Backups | Rails Integration | ??? | | ||
| -------- |:------------------:| -------:| -----------------:| -------:| -----------------:| ---:| | ||
| Weaviate | :white_check_mark: | WIP | WIP | WIP | | | | ||
| Qdrant | :white_check_mark: | WIP | WIP | WIP | | | | ||
| Milvus | :white_check_mark: | WIP | WIP | WIP | | | | ||
| Pinecone | :white_check_mark: | WIP | WIP | WIP | | | | ||
|
||
### Create an instance | ||
|
||
Choose the LLM provider you'll be using (OpenAI or Cohere) and retrieve the API key. | ||
|
||
Pick the vector search database you'll be using and instantiate the client: | ||
```ruby | ||
client = Vectorsearch::Weaviate.new( | ||
url: ENV["WEAVIATE_URL"], | ||
api_key: ENV["WEAVIATE_API_KEY"], | ||
llm: :openai, # or :cohere | ||
llm_api_key: ENV["OPENAI_API_KEY"] | ||
) | ||
|
||
# You can instantiate any other supported vector search database: | ||
client = Vectorsearch::Milvus.new(...) | ||
client = Vectorsearch::Qdrant.new(...) | ||
client = Vectorsearch::Pinecone.new(...) | ||
``` | ||
|
||
```ruby | ||
# Creating the default schema | ||
client.create_default_schema | ||
``` | ||
|
||
```ruby | ||
# Store your documents in your vector search database | ||
client.add_texts( | ||
texts: [ | ||
"Begin by preheating your oven to 375°F (190°C). Prepare four boneless, skinless chicken breasts by cutting a pocket into the side of each breast, being careful not to cut all the way through. Season the chicken with salt and pepper to taste. In a large skillet, melt 2 tablespoons of unsalted butter over medium heat. Add 1 small diced onion and 2 minced garlic cloves, and cook until softened, about 3-4 minutes. Add 8 ounces of fresh spinach and cook until wilted, about 3 minutes. Remove the skillet from heat and let the mixture cool slightly.", | ||
"In a bowl, combine the spinach mixture with 4 ounces of softened cream cheese, 1/4 cup of grated Parmesan cheese, 1/4 cup of shredded mozzarella cheese, and 1/4 teaspoon of red pepper flakes. Mix until well combined. Stuff each chicken breast pocket with an equal amount of the spinach mixture. Seal the pocket with a toothpick if necessary. In the same skillet, heat 1 tablespoon of olive oil over medium-high heat. Add the stuffed chicken breasts and sear on each side for 3-4 minutes, or until golden brown." | ||
] | ||
) | ||
``` | ||
|
||
```ruby | ||
# Retrieve similar documents based on the query string passed in | ||
client.similarity_search( | ||
query:, | ||
k: # number of results to be retrieved | ||
) | ||
``` | ||
```ruby | ||
# Retrieve similar documents based on the embedding passed in | ||
client.similarity_search_by_vector( | ||
embedding:, | ||
k: # number of results to be retrieved | ||
) | ||
``` | ||
```ruby | ||
# Q&A-style querying based on the question passed in | ||
client.ask( | ||
question: | ||
) | ||
``` | ||
|
||
## Development | ||
|
||
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. | ||
|
||
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org). | ||
|
||
## Contributing | ||
|
||
Bug reports and pull requests are welcome on GitHub at https://github.com/andreibondarev/langchain. | ||
|
||
## License | ||
|
||
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# frozen_string_literal: true | ||
|
||
require "bundler/gem_tasks" | ||
require "rspec/core/rake_task" | ||
|
||
RSpec::Core::RakeTask.new(:spec) | ||
|
||
task default: :spec |
Oops, something went wrong.