minds_sdk 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7d338a8c7a60751a9ff07a8e0a80b88d5a41c8d725913d20b9a48e8101ac862
-  data.tar.gz: 5f6df32b49f25319e67d1ac7b2992bd6dd89922176f46ad5819b08aad119e698
+  metadata.gz: c87aafd23aa3c79beffb7e71f2e8c5559cdeacd4d9ea313a918959d3c467f7c6
+  data.tar.gz: 50968756d64771da955cbbcdfe0a4f56222c01b6a1a5d4228b0916d0e2e34cf3
 SHA512:
-  metadata.gz: f481f5d03353c3199685763970b6c0b78c2787819d8222bb9ad8b18e71812c9de90736400ae8ace9c21ca94b529c5267845250b595e4199735e7493af358c935
-  data.tar.gz: 93b0f55f6be94511d2172324804f6ecc7a8c2f457beb0fc17804970596305f16e1be3afdb1622996f4149938a9db5b7d38caeb401ff284a9b310c590d6cb627d
+  metadata.gz: 0cb27972f74e235847215349ae2ff1d43c3dd157918954d7987e3ee1d1327d4239e13180213fd7c8fcf95abedb47b3c1a059dde0e22c614b24dabd86868e8385
+  data.tar.gz: 5a9e256939116119fe9b2e5252dadcdc15cc5fc8083f9434bd296005e47ccff265ade9922db54a6c9554dcf895501acd15b173a9fafb84419fb41e2cd5e8d6e6

data/README.md

@@ -1,5 +1,9 @@
 # Minds Ruby SDK
-[![Gem Version](https://badge.fury.io/rb/minds_sdk.svg)](https://badge.fury.io/rb/minds_sdk)
+[![Gem Version](https://img.shields.io/gem/v/minds_sdk)](https://rubygems.org/gems/minds_sdk)
+[![Ruby](https://img.shields.io/badge/ruby->=3.0.0-ruby.svg)](https://www.ruby-lang.org/en/)
+[![Documentation](https://img.shields.io/badge/docs-rubydoc.info-blue.svg)](https://www.rubydoc.info/gems/minds_sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 
 Minds Ruby SDK provides an interface to interact with the Minds AI system API. It allows you to create and manage "minds" (artificial intelligences), create chat completions, and manage data sources.
 

data/lib/minds/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minds
   class Client
     include Minds::RestClient

data/lib/minds/config/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minds
   module Config
     class Base

data/lib/minds/datasources.rb

@@ -1,6 +1,6 @@
 module Minds
   class DatabaseConfig
-    attr_reader :name, :engine, :description, :connection_data, :tables, :created_at
+    attr_accessor :name, :engine, :description, :connection_data, :tables, :created_at
 
     def initialize(name:, engine:, description:, connection_data: {}, tables: [], created_at: nil)
       @name = name
@@ -28,6 +28,7 @@ module Minds
     def initialize(client:)
       @client = client
     end
+
     # Create a new datasource and return it
     #
     # @param ds_config [DatabaseConfig] datasource configuration
@@ -36,23 +37,41 @@ module Minds
     # @option ds_config [String] :description Description of the database. Used by mind to understand what data can be retrieved from it.
     # @option ds_config [Hash] :connection_data (optional) Credentials to connect to the database
     # @option ds_config [Array<String>] :tables (optional) List of allowed tables
-    # @param replace [Boolean] If true, replaces an existing datasource with the same name
+    # @param update [Boolean] If true, to update datasourse if exists, default is false
     # @return [Datasource] The created datasource object
-    def create(ds_config, replace = false)
+    # @raise [ObjectNotSupported] If datasource type is not supported
+    #
+    # @example
+    #   config = DatabaseConfig.new(
+    #     name: 'sales_db',
+    #     engine: 'postgres',
+    #     connection_data: {
+    #       host: 'localhost',
+    #       port: 5432,
+    #       user_name: "test"
+    #       password: "test"
+    #     }
+    #   )
+    #   datasource = datasources.create(config)
+    #
+    def create(ds_config, update = false)
       name = ds_config.name
-      if replace
-        begin
-          find(name)
-          destroy(name, force: true)
-        end
-      end
-      @client.post(path: "datasources", parameters: ds_config.to_h)
+
+      path = "datasources"
+      path += "/#{name}" if update
+
+      @client.send(update ? :put : :post, path: path, parameters: ds_config.to_h)
       find(name)
     end
 
-    # Returns a list of all datasources
+    # Return a list of datasources
     #
     # @return [Array<Datasource>] An array of Datasource objects
+    #
+    # @example
+    #   datasources = datasources.all
+    #   datasources.each { |ds| puts ds.name }
+    #
     def all
       data = @client.get(path: "datasources")
       return [] if data.empty?
@@ -64,11 +83,16 @@ module Minds
       end
     end
 
-    # Get a datasource by name
+    # Find a datasource by name
     #
     # @param name [String] The name of the datasource to find
     # @return [Datasource] The found datasource object
     # @raise [ObjectNotSupported] If the datasource type is not supported
+    #
+    # @example
+    #   datasource = datasources.find('sales_db')
+    #   puts datasource.engine
+    #
     def find(name)
       data = @client.get(path: "datasources/#{name}")
       if data["engine"].nil?
@@ -77,10 +101,18 @@ module Minds
       Datasource.new(**data.transform_keys(&:to_sym))
     end
 
-    # Destroy (delete) a datasource by name
+    # Delete a datasource
+    #
+    # @param name [String]  Datasource name to delete
+    # @param force [Boolean] Whether to force delete from all minds
+    #
+    # @example
+    #   # Simple delete
+    #   datasources.destroy('old_db')
+    #
+    #   # Force delete
+    #   datasources.destroy('old_db', force: true)
     #
-    # @param name [String] The name of the datasource to delete
-    # @param force: if true -remove from all minds, default: false
     def destroy(name, force: false)
       data = force ? { cascade: true } : nil
       @client.delete(path: "datasources/#{name}", parameters: data)

data/lib/minds/minds.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "openai"
 require "uri"
 
@@ -5,7 +7,7 @@ module Minds
   DEFAULT_PROMPT_TEMPLATE = "Use your database tools to answer the user's question: {{question}}"
 
   class Mind
-    attr_accessor :name, :model_name, :provider, :parameters, :created_at, :updated_at, :datasources
+    attr_reader :name, :model_name, :provider, :parameters, :created_at, :updated_at, :datasources, :prompt_template
 
     def initialize(client, attributes = {})
       @client = client
@@ -20,7 +22,7 @@ module Minds
       @datasources = attributes["datasources"]
     end
 
-    # Update the mind with new parameters
+    # Update mind
     #
     # @param name [String, nil] New name of the mind (optional)
     # @param model_name [String, nil] New LLM model name (optional)
@@ -29,20 +31,19 @@ module Minds
     # @param datasources [Array<String, Datasource, DatabaseConfig>, nil] Alter list of datasources used by mind (optional)
     #   Datasource can be passed as:
     #   - String: name of the datasource
-    #   - Datasource object (Minds::Resources::Datasource)
-    #   - DatabaseConfig object (Minds::Resources::DatabaseConfig), in this case datasource will be created
+    #   - Datasource object (Minds::Datasource)
+    #   - DatabaseConfig object (Minds::DatabaseConfig), in this case datasource will be created
     # @param parameters [Hash, nil] Alter other parameters of the mind (optional)
     # @return [void]
     def update(name: nil, model_name: nil, provider: nil, prompt_template: nil, datasources: nil, parameters: nil)
       data = {}
-
       ds_names = []
       datasources.each do |ds|
         ds_name = @client.minds.check_datasource(ds)
         ds_names << ds_name
-        data["datasources"] = ds_names
       end if datasources
 
+      data["datasources"] = ds_names if !ds_names.empty?
       data["name"] = name if name
       data["model_name"] = model_name if model_name
       data["provider"] = provider if provider
@@ -52,15 +53,26 @@ module Minds
       @client.patch(path: "projects/#{@project}/minds/#{@name}", parameters: data)
 
       @name = name if name && name != @name
+
+      updated_mind = @client.minds.find(@name)
+
+      @model_name = updated_mind.model_name
+      @datasources = updated_mind.datasources
+      @parameters = updated_mind.parameters
+      @prompt_template = updated_mind.prompt_template
+      @provider = updated_mind.provider
+      @created_at = updated_mind.created_at
+      @updated_at = updated_mind.updated_at
+      true
     end
 
-    # Add a datasource to the mind
+    # Add datasource to mind
     #
-    # @param datasource [String, Datasource, DatabaseConfig] The datasource to add
+    # @param datasource [String, Datasource, DatabaseConfig] Datasource to add
     #   Can be passed as:
     #   - String: name of the datasource
-    #   - Datasource object (Minds::Resources::Datasource)
-    #   - DatabaseConfig object (Minds::Resources::DatabaseConfig), in this case datasource will be created
+    #   - Datasource object (Minds::Datasource)
+    #   - DatabaseConfig object (Minds::DatabaseConfig), in this case datasource will be created
     # @return [void]
     def add_datasources(datasource)
       ds_name = @client.minds.check_datasource(datasource)
@@ -69,15 +81,18 @@ module Minds
 
       mind = @client.minds.find(@name)
       @datasources = mind.datasources
+
+      true
     end
 
-    # Delete a datasource from the mind
+    # Remove datasource from mind
     #
-    # @param datasource [String, Datasource] The datasource to delete
+    # @param datasource [String, Datasource] Datasource to remove
     #   Can be passed as:
     #   - String: name of the datasource
-    #   - Datasource object (Minds::Resources::Datasource)
+    #   - Datasource object (Minds::Datasource)
     # @return [void]
+    # @raise [ArgumentError] If datasource type is invalid
     def destroy_datasources(datasource)
       if datasource.is_a?(Datasource)
         datasource = datasource.name
@@ -88,6 +103,7 @@ module Minds
 
       mind = @client.minds.find(@name)
       @datasources = mind.datasources
+      true
     end
 
     # Call mind completion
@@ -125,9 +141,14 @@ module Minds
       @project = "mindsdb"
     end
 
-    # Returns a list of all minds
+    # Lists minds
+    #
+    # @return [Array<Mind>] List of minds
+    #
+    # @example
+    #   minds = minds.all
+    #   minds.each { |mind| puts mind.name }
     #
-    # @return [Array<Mind>] An array of Mind objects
     def all
       data = @client.get(path: "projects/#{@project}/minds")
       return [] if data.empty?
@@ -135,19 +156,28 @@ module Minds
       data.map { |item| Mind.new(@client, item) }
     end
 
-    # Get a mind by name
+    # Find a mind by name
     #
     # @param name [String] The name of the mind to find
     # @return [Mind] The found mind object
+    #
+    # @example
+    #   mind = minds.find('sales_assistant')
+    #   puts mind.model_name
+    #
     def find(name)
       data = @client.get(path: "projects/#{@project}/minds/#{name}")
       Mind.new(@client, data)
     end
 
-    # Drop (delete) a mind by name
+    # Delete a mind
     #
     # @param name [String] The name of the mind to delete
     # @return [void]
+    #
+    # @example
+    #   minds.destroy('old_assistant')
+    #
     def destroy(name)
       @client.delete(path: "projects/#{@project}/minds/#{name}")
     end
@@ -165,13 +195,24 @@ module Minds
     #   - DatabaseConfig object (Minds::DatabaseConfig), in this case datasource will be created
     # @param parameters [Hash, nil] Other parameters of the mind (optional)
     # @param replace [Boolean] If true, remove existing mind with the same name (default: false)
+    # @param update [Boolean] If true, to update mind if exists(default: false)
     # @return [Mind] The created mind object
-    def create(name:, model_name: nil, provider: nil, prompt_template: nil, datasources: nil, parameters: nil, replace: false)
+    #
+    # @example Simple creation
+    #   mind = minds.create(name: 'sales_assistant', model_name: 'gpt-4')
+    #
+    # @example Creation with datasources
+    #   mind = minds.create(
+    #     name: 'sales_assistant',
+    #     model_name: 'gpt-4',
+    #     datasources: ['sales_db'],
+    #     prompt_template: 'Analyze sales data: {{question}}'
+    #   )
+    #
+    def create(name:, model_name: nil, provider: nil, prompt_template: nil, datasources: nil, parameters: nil, replace: false, update: false)
       if replace
-        begin
-          find(name)
-          destroy(name)
-        end
+        find(name)
+        destroy(name)
       end
 
       ds_names = []
@@ -192,7 +233,9 @@ module Minds
         datasources: ds_names
       }
 
-      @client.post(path: "projects/#{@project}/minds", parameters: data)
+      path = "projects/#{@project}/minds"
+      path += "/#{name}" if update
+      @client.send(update ? :put : :post, path: path, parameters: data)
       find(name)
     end
 
@@ -217,6 +260,8 @@ module Minds
       return unless ds.is_a?(DatabaseConfig)
 
       @client.datasources.find(ds.name)
+    rescue Faraday::ResourceNotFound
+      @client.datasources.create(ds)
     end
   end
 end

data/lib/minds/rest_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Minds
   module RestClient
     def get(path:)
@@ -16,6 +18,12 @@ module Minds
       end&.body
     end
 
+    def put(path:, parameters:)
+      conn.put(uri(path: path)) do |req|
+        req.body = parameters.to_json
+      end&.body
+    end
+
     def delete(path:, parameters: nil)
       conn.delete(uri(path: path)) do |req|
         req.body = parameters.to_json

data/lib/minds/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Minds
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/minds.rb

@@ -12,6 +12,11 @@ require_relative "minds/minds"
 
 module Minds
   class MiddlewareErrors < Faraday::Middleware
+    ##
+    # Handles API error responses and provides detailed logging
+    #
+    # @param env [Hash] The Faraday environment hash
+    # @raise [Faraday::Error] Re-raises the original error after logging
     def call(env)
       @app.call(env)
     rescue Faraday::Error => e

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: minds_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - tungnt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2024-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 7.3.1
 description: Official Ruby SDK for Minds
 email:
 - tungnguyen120301@gmail.com