bx_builder_chain 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9398159d26923acd8ac5f3c51675e2934dd14a89f1fd97ce088f7cd751721425
-  data.tar.gz: 1f272643f2c6661e11a72e7221f2497cbc27a8f843b91b71a31a63df0d184e13
+  metadata.gz: 006f8200cd1577b6ad0687b1607cad5aabf833971d3a3e3fe2f7718988ec6fbb
+  data.tar.gz: 51be4ca4f480ab7ed47582fc2482b10e53e2a858eb798889ed65cbcf85f76e91
 SHA512:
-  metadata.gz: 88d787f0ab0ff4e7a33ef5faeae4f8bb0ae18834bd3aa36fe0d82aeedee57ae9e7f6cea770915924638b08ff2c185be83fa7a132fd40f3effe602534d1528bac
-  data.tar.gz: c943c30ea2343e02d1c7ac98ac581b5da2ad821eb33e75595bde76756b0245785f1756671be5850350126ff6fe2d3839ef66906535f2cd5fe4a42c3a7403e057
+  metadata.gz: 4f2e15d46fa5c06974fa10df37d27204d30bf92e4615a0c77dfbed4a0e84091a0e304ae5b98e52b2434c8937d97616e4d4e3213f959226657c84075431663b9c
+  data.tar.gz: b4762d1c53c6ccc6fc434f53ed058f55273798af70da586e722981a53159d49fc93f197321a7ece9b95b90c80d2c731c5de76d0830782e488571caf7cee8c682

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.6"
 end

data/lib/generators/bx_builder_chain/templates/app/views/bx_builder_chain/test/form.html.erb

@@ -23,6 +23,10 @@
         height: 340px;
     }
 
+    div.fullwidth {
+        width: 100%;
+    }
+
     form {
         width: 100%;
     }
@@ -73,6 +77,19 @@
     .console_message {
         white-space: pre-line; /* To respect new lines in the content */
     }
+
+    div.fullwidth .form-group {
+        width: 80%;
+        float: left;
+    }
+
+    div.fullwidth .actions {
+        float: right;
+        margin-top: 17px;
+    }
+    #file_list button {
+        margin-left: 10px;
+    }
 </style>
 
 <div class="page_wrapper">
@@ -119,7 +136,24 @@
         <% end %>
     </div>
     <div style="clear: both;"></div>
+    <div class="form_wrapper fullwidth">
+        <h2>Retrieve Files</h2>
 
+        <%= form_tag(bx_builder_chain_documents_list_path, method: :get, id: 'list_form') do %>
+            <div class="form-group">
+                <label for="current_user_groups">Enter User ID:</label>
+                <%= text_field_tag 'current_user_groups', 1, class: 'form-control' %>
+            </div>
+
+            <div class="actions">
+                <%= submit_tag "Retrieve Files", class: 'btn btn-primary' %>
+            </div>
+        <% end %>
+
+        <div style="clear: both;"></div>
+        <ul id="file_list"></ul>
+    </div>
+    <div style="clear: both;"></div>
     <!-- Console box -->
     <div class="console_wrapper">
         <div class="console_message">
@@ -161,4 +195,83 @@
             });
         });
     });
+    document.addEventListener('DOMContentLoaded', function () {
+        const listForm = document.querySelector('#list_form');
+        const fileList = document.querySelector('#file_list');
+        const consoleBox = document.querySelector('.console_message');
+
+        listForm.addEventListener('submit', async function (event) {
+            event.preventDefault();
+
+            consoleBox.textContent = "Retrieving files...";
+            const current_user_groups = event.target.current_user_groups.value;
+            const endpoint = `${
+                event.target.action
+            }?current_user_groups=${current_user_groups}`;
+
+            try {
+                let response = await fetch(endpoint, {
+                    method: 'GET',
+                    headers: {
+                        'Content-Type': 'application/json'
+                    }
+                });
+
+                if (response.ok) {
+                    let files = await response.json();
+
+                    fileList.innerHTML = ''; // Clear the file list
+
+                    const current_user_groups = event.target.current_user_groups.value;
+                    files.forEach(file => {
+                        let listItem = document.createElement('li');
+                        listItem.textContent = file.name; // Assuming the file object has a 'name' property
+
+                        let deleteBtn = document.createElement('button');
+                        deleteBtn.textContent = "Delete";
+                        deleteBtn.addEventListener('click', async function () {
+                            event.preventDefault();
+                            await deleteFile(file.id, current_user_groups); // Assuming the file object has an 'id' property
+                        });
+
+                        listItem.appendChild(deleteBtn);
+                        fileList.appendChild(listItem);
+                    });
+
+                    consoleBox.textContent = "Files retrieved successfully.";
+                } else {
+                    let errorData = await response.json();
+                    consoleBox.textContent = errorData.error || "An error occurred while retrieving files.";
+                }
+            } catch (error) {
+                consoleBox.textContent = "Failed to retrieve files. Please try again.";
+            }
+        });
+
+        async function deleteFile(fileId, current_user_groups) {
+            consoleBox.textContent = "Deleting file...";
+
+            try {
+                let response = await fetch('/bx_builder_chain/documents/delete', {
+                    method: 'DELETE',
+                    headers: {
+                        'Content-Type': 'application/json'
+                    },
+                    body: JSON.stringify(
+                        {ids: [fileId], current_user_groups: current_user_groups}
+                    )
+                });
+
+                if (response.ok) {
+                    consoleBox.textContent = "File deleted successfully.";
+                    document.querySelector('#list_form .actions input').click()
+                } else {
+                    let errorData = await response.json();
+                    consoleBox.textContent = errorData.error || "An error occurred while deleting the file.";
+                }
+            } catch (error) {
+                consoleBox.textContent = "Failed to delete file. Please try again.";
+            }
+        }
+    });
 </script>

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