bx_builder_chain 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9398159d26923acd8ac5f3c51675e2934dd14a89f1fd97ce088f7cd751721425
-  data.tar.gz: 1f272643f2c6661e11a72e7221f2497cbc27a8f843b91b71a31a63df0d184e13
+  metadata.gz: 29bc947f6ea34473e5155d3baf25d46056fde59bbdc24f8f79724e4d135cebd6
+  data.tar.gz: e1bfb8c5329ed636f0b31935c8010aea7fa4820a90444bbe8275c23ae325da65
 SHA512:
-  metadata.gz: 88d787f0ab0ff4e7a33ef5faeae4f8bb0ae18834bd3aa36fe0d82aeedee57ae9e7f6cea770915924638b08ff2c185be83fa7a132fd40f3effe602534d1528bac
-  data.tar.gz: c943c30ea2343e02d1c7ac98ac581b5da2ad821eb33e75595bde76756b0245785f1756671be5850350126ff6fe2d3839ef66906535f2cd5fe4a42c3a7403e057
+  metadata.gz: 249e336c873a34f643c84d97c08f65c8af3ad517e961410711b23d4e312db1e88e48ea1f11e2a10cdd50507b3a6811d0912e0256e601e401a36347d01788416b
+  data.tar.gz: 9b77e5330cebdb6008b8d7c7d4a8771fb1fb607e22af0bbf0c1e7867ae14d65c2e902717af15b487de43c6db2da81df3c784f0c0026f0b4fded16d2bf01bbbfa

data/README.md

@@ -20,30 +20,57 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
     $ gem install bx_builder_chain
 
-TODO: add rake task to create db structure
-### Optional
 
-generate the endpoint & Active admin contollers for Builder Chain
+### Setup
 
-    $ rails generate builder_chain:endpoints
+generate the endpoints & Active admin contollers for Builder Chain along with the DB migrations
+
+    $ rails generate builder_chain:install
 
 this will add the following endpoint controllers
  - File upload
+ - List files
+ - Delete file
  - OpenAi ask / completion
  - ActiveAdmin documents controller
 
+It will also add a test view / controller for testing the endpoints. ensure this is removed prior to production release
+
 ## Usage
 ```ruby
 require "bx_builder_chain"
 ```
 
+edit the initializer config 'bx_builder_chain.rb' setup the api keys and db credentials
+```
+BxBuilderChain.configure do |config|
+  config.openai_api_key = ENV['OPENAI_API_KEY']
+
+  # for db use this
+  config.pg_url = ENV['DB_URL'] || nil # eg 'postgres://postgres:password@localhost:5432/my_db'
+
+  # or this - pg_url with take preference
+  config.database_host = ENV['DB_HOSTNAME'] || 'localhost'
+  config.database_name = ENV['DB_NAME']
+  config.database_user = ENV['DB_USER']
+  config.database_password = ENV['DB_PASSWORD']
+  config.database_port = ENV['DB_PORT'] || '5432' # Defaulting to 5432 if not set
+
+  config.public_namespace = "public"
+  config.threshold = 0.25
+  config.default_prompt_template = "Context information is below
+  --------------------
+  %{context}
+  --------------------
+  Given the context information and not prior knowledge
+  answer the question: %{question}"
+end
+```
+
 create the llm and client
 ```ruby
-llm = BxBuilderChain::Llm::OpenAi.new(api_key: 'open-ai-api-key')
 client = BxBuilderChain::Vectorsearch::Pgvector.new(
-      url: 'postgres://postgres:password@localhost:5432/test', # postgres db url
-      table_name: "embeddings", # table name for the documents to be stored
-      llm: llm,
+      llm: BxBuilderChain::Llm::OpenAi.new,
       namespace: user_id # default is nil, nil is used for global public documents
     )
 ```
@@ -68,6 +95,22 @@ my_docx = "path/to/my.docx"
 client.add_data(paths: [my_pdf, my_text, my_docx])
 ```
 
+Or via the service object
+```ruby
+my_pdf = "path/to/my.pdf"
+my_text = "path/to/my.txt"
+my_docx = "path/to/my.docx"
+
+service = DocumentUploadService.new(
+    files: [my_pdf, my_text, my_docx],
+    user_groups: current_user_document_groups, # optional defaults to ['public'] an uses the first value to store the docs
+    client_class_name: CLIENT_CLASS_NAME, # optional defaults to 'BxBuilderChain::Vectorsearch::Pgvector'
+    llm_class_name: LLM_CLASS_NAME # optional defaults to 'BxBuilderChain::Llm::OpenAi'
+)
+
+result = service.upload_and_process
+```
+
 Then ask the question
 ```ruby
 client.ask(question: "What is Frogger?")

data/lib/bx_builder_chain/utils/token_length/open_ai_validator.rb

@@ -39,7 +39,8 @@ module BxBuilderChain
         def self.token_limit(model_name)
           TOKEN_LIMITS[model_name]
         end
-                def self.validate_max_tokens!(content, model_name, options = {})
+        
+        def self.validate_max_tokens!(content, model_name, options = {})
           text_token_length = if content.is_a?(Array)
             content.sum { |item| token_length(item.to_json, model_name, options) }
           else

data/lib/bx_builder_chain/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BxBuilderChain
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bx_builder_chain
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Paul Ketelle
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-02 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk