Merge branch 'main' into main

Author: Abiji-2020

.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: "MindsDB CLA Assistant"
+on:
+  issue_comment:
+    types: [created]
+  pull_request_target:
+    types: [opened,closed,synchronize]    
+jobs:
+  CLAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Assistant"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/[email protected]
+        env: 
+          GITHUB_TOKEN: ${{ secrets.CLA_TOKEN }}          
+          PERSONAL_ACCESS_TOKEN : ${{ secrets.CLA_TOKEN }}
+        with: 
+          path-to-signatures: 'assets/contributions-agreement/cla.json'
+          # Add path to the CLA here
+          path-to-document: 'https://github.com/mindsdb/mindsdb/blob/main/assets/contributions-agreement/individual-contributor.md'
+          branch: 'cla'
+          allowlist: bot*, ZoranPandovski, torrmal, Stpmax, mindsdbadmin, ea-rus, tmichaeldb, dusvyat, hamishfagg, MinuraPunchihewa, martyna-mindsdb, lucas-koontz

README.md

@@ -149,7 +149,9 @@ client.datasources.drop('my_datasource')
 ```
 >Note: The SDK currently does not support automatically removing a data source if it is no longer connected to any mind.
 
-# Other SDK's
 
-Go SDK : https://github.com/Abiji-2020/minds-go-sdk
 
+
+### Other SDKs
+#### [Command-Line](https://github.com/Better-Boy/minds-cli-sdk)
+#### [Go SDK](https://github.com/Abiji-2020/minds-go-sdk)

assets/contributions-agreement/cla.json

@@ -1,6 +1,6 @@
 __title__ = 'minds_sdk'
 __package_name__ = 'minds'
-__version__ = '1.0.7'
+__version__ = '1.0.8'
 __description__ = 'An AI-Data Mind is an LLM with the built-in power to answer data questions for Agents'
 __email__ = '[email protected]'
 __author__ = 'MindsDB Inc'

minds/__about__.py

@@ -16,11 +16,12 @@ class DatabaseConfig(BaseModel):
 class Datasource(DatabaseConfig):
     ...
 
+
 class Datasources:
     def __init__(self, client):
         self.api = client.api
 
-    def create(self, ds_config: DatabaseConfig, replace=False):
+    def create(self, ds_config: DatabaseConfig, update=False):
         """
         Create new datasource and return it
 
@@ -30,19 +31,16 @@ def create(self, ds_config: DatabaseConfig, replace=False):
            - description: str, description of the database. Used by mind to know what data can be got from it.
            - connection_data: dict, optional, credentials to connect to database
            - tables: list of str, optional, list of allowed tables
+        :param update: if true - to update datasourse if exists, default is false
         :return: datasource object
         """
 
         name = ds_config.name
 
-        if replace:
-            try:
-                self.get(name)
-                self.drop(name)
-            except exc.ObjectNotFound:
-                ...
-
-        self.api.post('/datasources', data=ds_config.model_dump())
+        if update:
+            self.api.put('/datasources', data=ds_config.model_dump())
+        else:
+            self.api.post('/datasources', data=ds_config.model_dump())
         return self.get(name)
 
     def list(self) -> List[Datasource]:
@@ -76,11 +74,15 @@ def get(self, name: str) -> Datasource:
             raise exc.ObjectNotSupported(f'Wrong type of datasource: {name}')
         return Datasource(**data)
 
-    def drop(self, name: str):
+    def drop(self, name: str, force=False):
         """
         Drop datasource by name
 
         :param name: name of datasource
+        :param force: if True - remove from all minds, default: False
         """
+        data = None
+        if force:
+            data = {'cascade': True}
 
-        self.api.delete(f'/datasources/{name}')
+        self.api.delete(f'/datasources/{name}', data=data)

minds/datasources/datasources.py

@@ -18,3 +18,6 @@ class Unauthorized(Exception):
 class UnknownError(Exception):
     ...
 
+
+class MindNameInvalid(Exception):
+    ...

minds/exceptions.py

@@ -1,16 +1,12 @@
 from typing import List, Union, Iterable
-from urllib.parse import urlparse, urlunparse
-from datetime import datetime
-
+import utils
 from openai import OpenAI
-
+import minds.utils as utils
 import minds.exceptions as exc
-
 from minds.datasources import Datasource, DatabaseConfig
 
 DEFAULT_PROMPT_TEMPLATE = 'Use your database tools to answer the user\'s question: {{question}}'
 
-
 class Mind:
     def __init__(
         self, client, name,
@@ -25,7 +21,7 @@ def __init__(
         self.api = client.api
         self.client = client
         self.project = 'mindsdb'
-
+        
         self.name = name
         self.model_name = model_name
         self.provider = provider
@@ -35,7 +31,11 @@ def __init__(
         self.parameters = parameters
         self.created_at = created_at
         self.updated_at = updated_at
-
+        base_url = utils.get_openai_base_url(self.api.base_url)
+        self.openai_client = OpenAI(
+            api_key=self.api.api_key,
+            base_url=base_url
+        )
         self.datasources = datasources
 
     def __repr__(self):
@@ -74,6 +74,9 @@ def update(
         :param parameters, dict: alter other parameters of the mind, optional
         """
         data = {}
+        
+        if name is not None:
+            utils.validate_mind_name(name)
 
         if datasources is not None:
             ds_names = []
@@ -156,23 +159,7 @@ def completion(self, message: str, stream: bool = False) -> Union[str, Iterable[
 
         :return: string if stream mode is off or iterator of ChoiceDelta objects (by openai)
         """
-        parsed = urlparse(self.api.base_url)
-
-        netloc = parsed.netloc
-        if netloc == 'mdb.ai':
-            llm_host = 'llm.mdb.ai'
-        else:
-            llm_host = 'ai.' + netloc
-
-        parsed = parsed._replace(path='', netloc=llm_host)
-
-        base_url = urlunparse(parsed)
-        openai_client = OpenAI(
-            api_key=self.api.api_key,
-            base_url=base_url
-        )
-
-        response = openai_client.chat.completions.create(
+        response = self.openai_client.chat.completions.create(
             model=self.name,
             messages=[
                 {'role': 'user', 'content': message}
@@ -216,7 +203,7 @@ def get(self, name: str) -> Mind:
         :param name: name of the mind
         :return: a mind object
         """
-
+        
         item = self.api.get(f'/projects/{self.project}/minds/{name}').json()
         return Mind(self.client, **item)
 
@@ -243,6 +230,7 @@ def create(
         datasources=None,
         parameters=None,
         replace=False,
+        update=False,
     ) -> Mind:
         """
         Create a new mind and return it
@@ -259,8 +247,12 @@ def create(
         :param datasources: list of datasources used by mind, optional
         :param parameters, dict: other parameters of the mind, optional
         :param replace: if true - to remove existing mind, default is false
+        :param update: if true - to update mind if exists, default is false
         :return: created mind
         """
+        
+        if name is not None:
+            utils.validate_mind_name(name)
 
         if replace:
             try:
@@ -284,7 +276,12 @@ def create(
         if 'prompt_template' not in parameters:
             parameters['prompt_template'] = DEFAULT_PROMPT_TEMPLATE
 
-        self.api.post(
+        if update:
+            method = self.api.put
+        else:
+            method = self.api.post
+
+        method(
             f'/projects/{self.project}/minds',
             data={
                 'name': name,

minds/minds.py

@@ -37,8 +37,12 @@ def get(self, url):
         _raise_for_status(resp)
         return resp
 
-    def delete(self, url):
-        resp = requests.delete(self.base_url + url, headers=self._headers())
+    def delete(self, url, data=None):
+        resp = requests.delete(
+            self.base_url + url,
+            headers=self._headers(),
+            json=data
+        )
 
         _raise_for_status(resp)
         return resp
@@ -53,6 +57,16 @@ def post(self, url, data):
         _raise_for_status(resp)
         return resp
 
+    def put(self, url, data):
+        resp = requests.put(
+            self.base_url + url,
+            headers=self._headers(),
+            json=data,
+        )
+
+        _raise_for_status(resp)
+        return resp
+
     def patch(self, url, data):
         resp = requests.patch(
             self.base_url + url,

minds/rest_api.py

@@ -0,0 +1,40 @@
+import re
+import minds.exceptions as exc
+from urllib.parse import urlparse, urlunparse
+
+def get_openai_base_url(base_url: str) -> str:
+    parsed = urlparse(base_url)
+
+    netloc = parsed.netloc
+    if netloc == 'mdb.ai':
+        llm_host = 'llm.mdb.ai'
+    else:
+        llm_host = 'ai.' + netloc
+
+    parsed = parsed._replace(path='', netloc=llm_host)
+
+    return urlunparse(parsed)
+
+
+def validate_mind_name(mind_name):
+    """
+    Validate the Mind name.
+
+    A valid Mind name should:
+    - Start with a letter
+    - Contain only letters, numbers, or underscores
+    - Have a maximum length of 32 characters
+    - Not contain spaces
+
+    Parameters:
+    mind_name (str): The Mind name to validate.
+
+    Returns:
+    bool: True if valid, False otherwise.
+    """
+    # Regular expression pattern
+    pattern = r'^[A-Za-z][A-Za-z0-9_]{0,31}$'
+
+    # Check if the Mind name matches the pattern
+    if not re.match(pattern, mind_name):
+        raise exc.MindNameInvalid("Mind name should start with a letter and contain only letters, numbers or underscore, with a maximum of 32 characters. Spaces are not allowed.")

minds/utils.py

@@ -9,7 +9,7 @@
 
 from minds.datasources.examples import example_ds
 
-from minds.exceptions import ObjectNotFound
+from minds.exceptions import ObjectNotFound, MindNameInvalid
 
 
 def get_client():
@@ -31,13 +31,14 @@ def test_datasources():
 
     # remove previous object
     try:
-        client.datasources.drop(example_ds.name)
+        client.datasources.drop(example_ds.name, force=True)
     except ObjectNotFound:
         ...
 
     # create
     ds = client.datasources.create(example_ds)
-    ds = client.datasources.create(example_ds, replace=True)
+    assert ds.name == example_ds.name
+    ds = client.datasources.create(example_ds, update=True)
     assert ds.name == example_ds.name
 
     # get
@@ -57,6 +58,7 @@ def test_minds():
     ds_name = 'test_datasource_'
     ds_name2 = 'test_datasource2_'
     mind_name = 'int_test_mind_'
+    invalid_mind_name = 'mind-123'
     mind_name2 = 'int_test_mind2_'
     prompt1 = 'answer in german'
     prompt2 = 'answer in spanish'
@@ -79,6 +81,13 @@ def test_minds():
     ds2_cfg.tables = ['home_rentals']
 
     # create
+    with pytest.raises(MindNameInvalid):
+        mind = client.minds.create(
+            invalid_mind_name,
+            datasources=[ds],
+            provider='openai'
+        )
+    
     mind = client.minds.create(
         mind_name,
         datasources=[ds],
@@ -90,11 +99,20 @@ def test_minds():
         datasources=[ds.name, ds2_cfg],
         prompt_template=prompt1
     )
+    mind = client.minds.create(
+        mind_name,
+        update=True,
+        datasources=[ds.name, ds2_cfg],
+        prompt_template=prompt1
+    )
 
     # get
     mind = client.minds.get(mind_name)
     assert len(mind.datasources) == 2
     assert mind.prompt_template == prompt1
+    
+    with pytest.raises(MindNameInvalid):
+        client.minds.get(invalid_mind_name)
 
     # list
     mind_list = client.minds.list()
@@ -106,6 +124,14 @@ def test_minds():
         datasources=[ds.name],
         prompt_template=prompt2
     )
+    
+    with pytest.raises(MindNameInvalid):
+        mind.update(
+            name=invalid_mind_name,
+            datasources=[ds.name],
+            prompt_template=prompt2
+        )
+    
     with pytest.raises(ObjectNotFound):
         # this name not exists
         client.minds.get(mind_name)
@@ -153,3 +179,6 @@ def test_minds():
     client.minds.drop(mind_name2)
     client.datasources.drop(ds.name)
     client.datasources.drop(ds2_cfg.name)
+    
+    with pytest.raises(MindNameInvalid):
+        client.minds.drop(invalid_mind_name)