nimbro-api 0.2.1__tar.gz → 0.2.2__tar.gz

{nimbro_api-0.2.1/src/nimbro_api.egg-info → nimbro_api-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nimbro-api
-Version: 0.2.1
+Version: 0.2.2
 Summary: A robust and flexible framework for API clients in Python
 Author-email: Bastian Pätzold <paetzoldbastian@gmail.com>
 Maintainer-email: Bastian Pätzold <paetzoldbastian@gmail.com>
@@ -42,6 +42,7 @@ Requires-Dist: pybase64; extra == "full"
 Requires-Dist: numpy; extra == "full"
 Requires-Dist: pillow; extra == "full"
 Requires-Dist: opencv-python; extra == "full"
+Requires-Dist: jsonschema; extra == "full"
 Dynamic: license-file
 
 # NimbRo API
@@ -65,6 +66,7 @@ Dynamic: license-file
 | Client | API Docs |
 |--------|----------|
 | [nimbro_api.openai.ChatCompletions](https://github.com/ptzld/nimbro-api/blob/main/src/nimbro_api/api/openai/client/chat_completions.py) | [Chat Completions](https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create) |
+| [nimbro_api.openai.Classify](https://github.com/ptzld/nimbro-api/blob/main/src/nimbro_api/api/openai/client/classify.py) | [Classify](https://docs.vllm.ai/en/latest/models/pooling_models/classify) |
 | [nimbro_api.openai.Embeddings](https://github.com/ptzld/nimbro-api/blob/main/src/nimbro_api/api/openai/client/embeddings.py) | [Embeddings](https://developers.openai.com/api/reference/resources/embeddings/methods/create) |
 | [nimbro_api.openai.Images](https://github.com/ptzld/nimbro-api/blob/main/src/nimbro_api/api/openai/client/images.py) | [Images](https://developers.openai.com/api/reference/resources/images/methods/generate) |
 | [nimbro_api.openai.Speech](https://github.com/ptzld/nimbro-api/blob/main/src/nimbro_api/api/openai/client/speech.py) | [Speech](https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create) |
@@ -123,7 +125,7 @@ Create and use a [ChatCompletions](https://github.com/ptzld/nimbro-api/blob/main
 ```python
 import nimbro_api
 # nimbro_api.set_api_key(name="OPENROUTER_API_KEY", key="supersecretkey") # alternatively, set API key here
-client = nimbro_api.openai.ChatCompletions(endpoint="OpenRouter", model="google/gemini-3-flash-preview")
+client = nimbro_api.openai.ChatCompletions(endpoint="OpenRouter", model="~google/gemini-flash-latest")
 success, message, response = client.prompt(text="Tell me a joke!")
 ```
 

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/README.md

@@ -19,6 +19,7 @@
 | Client | API Docs |
 |--------|----------|
 | [nimbro_api.openai.ChatCompletions](https://github.com/ptzld/nimbro-api/blob/main/src/nimbro_api/api/openai/client/chat_completions.py) | [Chat Completions](https://developers.openai.com/api/reference/resources/chat/subresources/completions/methods/create) |
+| [nimbro_api.openai.Classify](https://github.com/ptzld/nimbro-api/blob/main/src/nimbro_api/api/openai/client/classify.py) | [Classify](https://docs.vllm.ai/en/latest/models/pooling_models/classify) |
 | [nimbro_api.openai.Embeddings](https://github.com/ptzld/nimbro-api/blob/main/src/nimbro_api/api/openai/client/embeddings.py) | [Embeddings](https://developers.openai.com/api/reference/resources/embeddings/methods/create) |
 | [nimbro_api.openai.Images](https://github.com/ptzld/nimbro-api/blob/main/src/nimbro_api/api/openai/client/images.py) | [Images](https://developers.openai.com/api/reference/resources/images/methods/generate) |
 | [nimbro_api.openai.Speech](https://github.com/ptzld/nimbro-api/blob/main/src/nimbro_api/api/openai/client/speech.py) | [Speech](https://developers.openai.com/api/reference/resources/audio/subresources/speech/methods/create) |
@@ -77,7 +78,7 @@ Create and use a [ChatCompletions](https://github.com/ptzld/nimbro-api/blob/main
 ```python
 import nimbro_api
 # nimbro_api.set_api_key(name="OPENROUTER_API_KEY", key="supersecretkey") # alternatively, set API key here
-client = nimbro_api.openai.ChatCompletions(endpoint="OpenRouter", model="google/gemini-3-flash-preview")
+client = nimbro_api.openai.ChatCompletions(endpoint="OpenRouter", model="~google/gemini-flash-latest")
 success, message, response = client.prompt(text="Tell me a joke!")
 ```
 

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "nimbro-api"
-version = "0.2.1"
+version = "0.2.2"
 description = "A robust and flexible framework for API clients in Python"
 readme = "README.md"
 license = "BSD-3-Clause"
@@ -58,6 +58,7 @@ full = [
     "numpy",
     "pillow",
     "opencv-python",
+    "jsonschema",
 ]
 
 [project.urls]

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/src/nimbro_api/api/misc/base/vlm_gist_base.py

@@ -244,6 +244,8 @@ class VlmGistBase(ClientBase):
         assert_type_value(obj=output_dir, type_or_value=[None, str], name="argument 'output_dir'")
         if isinstance(output_dir, str):
             output_dir = os.path.realpath(output_dir)
+            assert_log(expression=os.path.isfile(output_dir), message="Expected argument 'output_dir' to not exist or point to an existing folder but it points to an existing file.")
+            os.makedirs(output_dir, exist_ok=True)
         assert_log(expression=IMPORT_ERROR is None, message=f"Visual utilities are not available due to missing dependencies: {IMPORT_ERROR}")
         if isinstance(result, str):
             success, message, result = read_json(file_path=result, name="result", logger=self._logger)
@@ -305,20 +307,34 @@ class VlmGistBase(ClientBase):
         if image is None:
             images = [None] * num_images
         else:
-            if not isinstance(image, list):
+            if isinstance(image, list):
+                assert_log(expression=len(image) == num_images, message=f"Expected argument 'image' provided as list to contain '{num_images}' item{'' if num_images == 1 else 's'} but got '{len(image)}'.")
+            elif os.path.isdir(image):
+                self._logger.debug("Argument 'image' provide as local path.")
+                path = image
+                image = sorted([os.path.join(image, item) for item in os.listdir(path) if os.path.isfile(os.path.join(path, item))])
+                self._logger.debug(f"Files in '{path}': {image}")
+                assert_log(expression=len(image) == num_images, message=f"Expected argument 'image' provided as path to contain '{num_images}' item{'' if num_images == 1 else 's'} but got '{len(image)}'.")
+            else:
+                assert_log(expression=num_images == 1, message=f"Expected argument 'image' to be provided as list containing '{num_images}' item{'' if num_images == 1 else 's'} but got 'str'.")
                 image = [image]
-            assert_log(expression=len(image) == num_images, message=f"Expected argument 'image' provided as list to contain '{num_images}' item{'' if num_images == 1 else 's'} but got '{len(image)}'.")
             images = [None] * num_images
             for i, item in enumerate(image):
                 if item is not None:
                     success, message, images[i], _ = parse_image_b64(image=item, logger=self._logger)
                     if not success:
                         self._logger.error(f"Failed to visualize result '{i + 1}' of '{num_images}': {message}")
+
         # visualize
+
+        self._logger.info(f"Visualizing '{num_images}' result{'' if num_images == 1 else 's'}.")
+
         visualizations = [None] * num_images
         paths = [None] * num_images
 
         for i, batch_item in enumerate(batch):
+            # TODO parallelize using batch.size and batch.threading
+
             # validate data
             if images[i] is None and image is not None:
                 continue
@@ -452,7 +468,7 @@ class VlmGistBase(ClientBase):
             if sum(item is None for item in points) == len(points):
                 points = None
 
-            # visualize
+            # draw
             self._logger.debug(f"Visualizing result '{i + 1}' of '{num_images}'.")
             tic = time.perf_counter()
             if vis_args is None:
@@ -481,7 +497,6 @@ class VlmGistBase(ClientBase):
                 success, visual = cv2.imencode('.png', visual)
                 if success:
                     visual = visual.tobytes()
-                    os.makedirs(output_dir, exist_ok=True)
                     out_path = os.path.join(output_dir, f"{i}_{datetime.datetime.now().isoformat()[:23].replace('-', '_').replace(':', '_').replace('.', '_')}.png")
                     with open(out_path, "wb") as file:
                         file.write(visual)
@@ -495,7 +510,8 @@ class VlmGistBase(ClientBase):
 
         # consolidate
         num_success = sum(item is not None for item in visualizations)
-        success = num_success == num_images
+        # success = num_success == num_images
+        success = True # to prevent any retry attempts
         if num_success == 0:
             visualizations = None
             paths = None
@@ -669,7 +685,10 @@ class VlmGistBase(ClientBase):
             f"{('thread' if settings['batch']['style'] == 'threading' else 'process')}"
             f"{'' if (settings['batch']['size'] if settings['batch']['size'] > 0 else len(image)) == 1 else ('s' if settings['batch']['style'] == 'threading' else 'es')}."
         )
-        self._logger.info(message)
+        if settings['message_process']:
+            self._logger.info(message)
+        else:
+            self._logger.debug(message)
 
         # full settings here instead of individual results
         data['run']['type'] = "batch"
@@ -709,7 +728,7 @@ class VlmGistBase(ClientBase):
         # extract batch results
         successes = [res[0] for res in results]
         failures = len(image) - sum(successes)
-        data['run']['success'] = failures == 0 # TODO keep 0 but make retry in batch mode only be applied to workers while using different retry for batch (zero or other setting)
+        data['run']['success'] = failures == 0
         duration = time.perf_counter() - stamp_global
         data['run']['message'] = (
             f"Processed batch with '{len(image)}' image{'' if len(image) == 1 else 's'} using "
@@ -945,8 +964,8 @@ class VlmGistBase(ClientBase):
                         except json.JSONDecodeError:
                             pass
                         else:
-                            data['structured_description']['logs'].append("Extracted possible structured description from string.")
-                            self._logger.warn(data['structured_description']['logs'][-1])
+                            data['structured_description']['logs'].append("Parsed text response as JSON.")
+                            self._logger.debug(data['structured_description']['logs'][-1])
                             break
                     else:
                         return False, "Failed to extract JSON from structured description received as string.", data
@@ -959,7 +978,10 @@ class VlmGistBase(ClientBase):
 
         # structured description must be list
         if not isinstance(description, list):
-            return False, f"Expected structured description to be of type 'list' but got '{type(description).__name__}'.", data
+            try:
+                return False, f"Expected structured description to be of type 'list' but got '{type(description).__name__}': {description}", data
+            except Exception:
+                return False, f"Expected structured description to be of type 'list' but got '{type(description).__name__}'.", data
 
         # obtain image dimensions if required
         dimensions = None

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/src/nimbro_api/api/misc/client/vlm_gist.py

@@ -15,7 +15,7 @@ default_settings = {
             'logger_severity': "warn",
             'endpoint': "OpenRouter",
             'model': "~google/gemini-pro-latest",
-            'reasoning_effort': "none"
+            'reasoning_effort': "minimal"
         },
         'system_prompt_role': "system",
         'system_prompt': "You are a visual perception system that identifies and analyzes objects and other visible features in an image.",
@@ -35,7 +35,7 @@ default_settings = {
             'logger_severity': "warn",
             'endpoint': "OpenRouter",
             'model': "~google/gemini-pro-latest",
-            'reasoning_effort': "none"
+            'reasoning_effort': "minimal"
         },
         'use_scene_description': False,
         'system_prompt_role': "system",
@@ -194,11 +194,13 @@ class VlmGist(Client):
                 - logger_severity (str | None): Logger severity applied to each worker in ["debug", "info", "warn", "error", "fatal", "off"] (str) or `None` to adopt global process-wide severity.
                 - size (int): Number of parallel workers when processing a list of images (>= 0). Use `0` to spawn one worker per image.
                 - style (str): Parallelization backend used for batch processing. One of ["threading", "multiprocessing"].
-                - retry (bool | int): Retry behavior for a single worker. The global 'retry' setting is applied to the entire batch, triggering retry when at least one worker failed (after using up all their retry attempts).
+                - retry (bool | int): Retry behavior for a single worker when passing multiple images.
+                  Then, the global 'retry' setting is applied to the entire batch, triggering retry when at least one worker failed (after using up all their retry attempts).
             retry (bool | int):
                 Defines retry behavior in failure cases, if the cause is eligible for retry:
                 - If `True`, retries indefinitely. If `False`, failure is returned immediately.
                 - Use a positive integer (`int`) to permit a specific number of retry attempts.
+                - Scope depends on mode (see 'batch.retry').
 
         Raises:
             UnrecoverableError: If 'name' is provided and does not refer to an existing setting.
@@ -239,7 +241,7 @@ class VlmGist(Client):
             result (str | dict):
                 A result returned by `run()` (for either a single image or a batch), either as the dictionary (`dict`) itself or as a path (`str`) to a JSON file containing it.
             image (str | bytes | list[str] | list[bytes] | None):
-                The image(s) corresponding to the result as a local path, URL, Base64 encoding (all `str`), or raw `bytes`.
+                The image(s) corresponding to the result as a local path to a file or a folder containing files, URL, Base64 encoding (all `str`), or raw `bytes`.
                 For a batch result, a `list` of length matching the batch size is required. If `None`, the image must be provided
                 within 'result', which requires the setting 'include_image' to have been enabled during the originating call to `run()`. Defaults to `None`.
             output_dir (str | None):

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/src/nimbro_api/api/misc/test/vlm_gist_test.py

@@ -578,7 +578,9 @@ def test_13_parallel_threads(n=10):
     client = VlmGist(settings={
         'batch.size': n,
         'batch.style': "threading",
-        'include_image': True
+        'batch.retry': 2,
+        'include_image': True,
+        'retry': False
     })
     images = [os.path.join(nimbro_api.__path__[0], "test", "assets", "test.png")] * n
     success, message, result = client.run(image=images)
@@ -592,7 +594,9 @@ def test_14_parallel_multiprocessing(n=10):
     client = VlmGist(settings={
         'batch.size': n,
         'batch.style': "multiprocessing",
-        'include_image': False
+        'batch.retry': 2,
+        'include_image': False,
+        'retry': False
     })
     images = [os.path.join(nimbro_api.__path__[0], "test", "assets", "test.png")] * n
     success, message, result = client.run(image=images)

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/src/nimbro_api/api/nimbro_vision_servers/base/dam_base.py

@@ -4,7 +4,7 @@ import time
 from nimbro_api.client import ClientBase
 from nimbro_api.utility.io import parse_image_b64
 from nimbro_api.utility.api import get_api_key, validate_endpoint, post_request
-from nimbro_api.utility.misc import assert_type_value, assert_keys, assert_log, format_obj
+from nimbro_api.utility.misc import UnrecoverableError, assert_type_value, assert_keys, assert_log, format_obj
 from nimbro_api.utility.string import is_base64
 from ..utility import get_status, get_health, get_flavors, load, unload
 
@@ -183,7 +183,9 @@ class DamBase(ClientBase):
                 return False, message, None
 
         # retrieve API key
-        api_key = self.get_api_key()[2]
+        success, message, api_key = self.get_api_key()
+        if not success:
+            raise UnrecoverableError(message)
 
         # construct payload
         headers = {
@@ -192,6 +194,8 @@ class DamBase(ClientBase):
             'HTTP-Referer': "https://github.com/ptzld/nimbro-api",
             'X-Title': "NimbRo API"
         }
+        if api_key == "":
+            del headers['Authorization']
         data = {
             'images': [image_file],
             'prompts': [prompts],

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/src/nimbro_api/api/nimbro_vision_servers/base/florence2_base.py

@@ -157,7 +157,9 @@ class Florence2Base(ClientBase):
                 return False, message, None
 
         # retrieve API key
-        api_key = self.get_api_key()[2]
+        success, message, api_key = self.get_api_key()
+        if not success:
+            raise UnrecoverableError(message)
 
         # construct payload
         headers = {
@@ -166,6 +168,8 @@ class Florence2Base(ClientBase):
             'HTTP-Referer': "https://github.com/ptzld/nimbro-api",
             'X-Title': "NimbRo API"
         }
+        if api_key == "":
+            del headers['Authorization']
         data = {
             'images': [image_file],
             'prompts': [self._settings['prompt']],

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/src/nimbro_api/api/nimbro_vision_servers/base/kosmos2_base.py

@@ -3,7 +3,7 @@ import time
 from nimbro_api.client import ClientBase
 from nimbro_api.utility.io import parse_image_b64
 from nimbro_api.utility.api import get_api_key, validate_endpoint, post_request
-from nimbro_api.utility.misc import assert_type_value, assert_log, format_obj
+from nimbro_api.utility.misc import UnrecoverableError, assert_type_value, assert_log, format_obj
 from ..utility import get_status, get_health, get_flavors, load, unload
 
 class Kosmos2Base(ClientBase):
@@ -152,7 +152,9 @@ class Kosmos2Base(ClientBase):
                 return False, message, None
 
         # retrieve API key
-        api_key = self.get_api_key()[2]
+        success, message, api_key = self.get_api_key()
+        if not success:
+            raise UnrecoverableError(message)
 
         # construct payload
         headers = {
@@ -161,6 +163,8 @@ class Kosmos2Base(ClientBase):
             'HTTP-Referer': "https://github.com/ptzld/nimbro-api",
             'X-Title': "NimbRo API"
         }
+        if api_key == "":
+            del headers['Authorization']
         data = {
             'images': [image_file],
             'prompts': [self._settings['prompt']],

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/src/nimbro_api/api/nimbro_vision_servers/base/mmgroundingdino_base.py

@@ -3,7 +3,7 @@ import time
 from nimbro_api.client import ClientBase
 from nimbro_api.utility.io import parse_image_b64
 from nimbro_api.utility.api import get_api_key, validate_endpoint, post_request
-from nimbro_api.utility.misc import assert_type_value, assert_log
+from nimbro_api.utility.misc import UnrecoverableError, assert_type_value, assert_log
 from ..utility import get_status, get_health, get_flavors, load, unload
 
 class MmGroundingDinoBase(ClientBase):
@@ -148,7 +148,9 @@ class MmGroundingDinoBase(ClientBase):
                 return False, message, None
 
         # retrieve API key
-        api_key = self.get_api_key()[2]
+        success, message, api_key = self.get_api_key()
+        if not success:
+            raise UnrecoverableError(message)
 
         # construct payload
         headers = {
@@ -157,6 +159,8 @@ class MmGroundingDinoBase(ClientBase):
             'HTTP-Referer': "https://github.com/ptzld/nimbro-api",
             'X-Title': "NimbRo API"
         }
+        if api_key == "":
+            del headers['Authorization']
         data = {
             'images': [image_file],
             'inference_parameters': [{

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/src/nimbro_api/api/nimbro_vision_servers/base/sam2_realtime_base.py

@@ -4,7 +4,7 @@ import copy
 from nimbro_api.client import ClientBase
 from nimbro_api.utility.io import parse_image_b64
 from nimbro_api.utility.api import get_api_key, validate_endpoint, post_request
-from nimbro_api.utility.misc import assert_type_value, assert_log
+from nimbro_api.utility.misc import UnrecoverableError, assert_type_value, assert_log
 from ..utility import get_status, get_health, get_flavors, load, unload
 
 class Sam2RealtimeBase(ClientBase):
@@ -187,7 +187,9 @@ class Sam2RealtimeBase(ClientBase):
             self._logger.debug(message)
 
         # retrieve API key
-        api_key = self.get_api_key()[2]
+        success, message, api_key = self.get_api_key()
+        if not success:
+            raise UnrecoverableError(message)
 
         # construct payload
         headers = {
@@ -196,6 +198,8 @@ class Sam2RealtimeBase(ClientBase):
             'HTTP-Referer': "https://github.com/ptzld/nimbro-api",
             'X-Title': "NimbRo API"
         }
+        if api_key == "":
+            del headers['Authorization']
         if prompts is None:
             data = {
                 'images': [image_file],

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/src/nimbro_api/api/nimbro_vision_servers/utility.py

@@ -2,7 +2,7 @@ import datetime
 
 import nimbro_api
 from nimbro_api.utility.api import get_request, post_request
-from nimbro_api.utility.misc import assert_type_value, assert_log
+from nimbro_api.utility.misc import UnrecoverableError, assert_type_value, assert_log
 
 def get_status(self, age):
     # parse arguments
@@ -41,7 +41,9 @@ def get_status(self, age):
         self._logger.debug(message)
 
     # retrieve API key
-    api_key = self.get_api_key()[2]
+    success, message, api_key = self.get_api_key()
+    if not success:
+        raise UnrecoverableError(message)
 
     # use status API
     headers = {
@@ -50,6 +52,8 @@ def get_status(self, age):
         'HTTP-Referer': "https://github.com/ptzld/nimbro-api",
         'X-Title': "NimbRo API"
     }
+    if api_key == "":
+        del headers['Authorization']
     success, message, response = get_request(
         api_name="NimbRo-Vision-Servers API",
         api_url=f"{self._endpoint['api_url']}/status",
@@ -132,7 +136,9 @@ def get_health(self, age):
         self._logger.debug(message)
 
     # retrieve API key
-    api_key = self.get_api_key()[2]
+    success, message, api_key = self.get_api_key()
+    if not success:
+        raise UnrecoverableError(message)
 
     # use health API
     headers = {
@@ -141,6 +147,8 @@ def get_health(self, age):
         'HTTP-Referer': "https://github.com/ptzld/nimbro-api",
         'X-Title': "NimbRo API"
     }
+    if api_key == "":
+        del headers['Authorization']
     success, message, response = get_request(
         api_name="NimbRo-Vision-Servers API",
         api_url=f"{self._endpoint['api_url']}/health",
@@ -210,7 +218,9 @@ def get_flavors(self, age):
         self._logger.debug(message)
 
     # retrieve API key
-    api_key = self.get_api_key()[2]
+    success, message, api_key = self.get_api_key()
+    if not success:
+        raise UnrecoverableError(message)
 
     # use model_flavors API
     headers = {
@@ -219,6 +229,8 @@ def get_flavors(self, age):
         'HTTP-Referer': "https://github.com/ptzld/nimbro-api",
         'X-Title': "NimbRo API"
     }
+    if api_key == "":
+        del headers['Authorization']
     success, message, response = get_request(
         api_name="NimbRo-Vision-Servers API",
         api_url=f"{self._endpoint['api_url']}/model_flavors",
@@ -295,7 +307,9 @@ def load(self, flavor=None, age=0):
     self._logger.debug(message)
 
     # retrieve API key
-    api_key = self.get_api_key()[2]
+    success, message, api_key = self.get_api_key()
+    if not success:
+        raise UnrecoverableError(message)
 
     # use load API
     headers = {
@@ -304,6 +318,8 @@ def load(self, flavor=None, age=0):
         'HTTP-Referer': "https://github.com/ptzld/nimbro-api",
         'X-Title': "NimbRo API"
     }
+    if api_key == "":
+        del headers['Authorization']
     success, message, _ = post_request(
         api_name="NimbRo-Vision-Servers API",
         api_url=f"{self._endpoint['api_url']}/load",
@@ -339,7 +355,9 @@ def unload(self):
     self._logger.debug(message)
 
     # retrieve API key
-    api_key = self.get_api_key()[2]
+    success, message, api_key = self.get_api_key()
+    if not success:
+        raise UnrecoverableError(message)
 
     # use unload API
     headers = {
@@ -348,6 +366,8 @@ def unload(self):
         'HTTP-Referer': "https://github.com/ptzld/nimbro-api",
         'X-Title': "NimbRo API"
     }
+    if api_key == "":
+        del headers['Authorization']
     success, message, response = post_request(
         api_name="NimbRo-Vision-Servers API",
         api_url=f"{self._endpoint['api_url']}/unload",

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/src/nimbro_api/api/openai/__init__.py

@@ -1,8 +1,9 @@
 from .client.chat_completions import ChatCompletions
+from .client.classify import Classify
 from .client.embeddings import Embeddings
 from .client.images import Images
 from .client.speech import Speech
 from .client.transcriptions import Transcriptions
 from .client.translations import Translations
 
-__all__ = ["ChatCompletions", "Embeddings", "Images", "Speech", "Transcriptions", "Translations"]
+__all__ = ["ChatCompletions", "Classify", "Embeddings", "Images", "Speech", "Transcriptions", "Translations"]

{nimbro_api-0.2.1 → nimbro_api-0.2.2}/src/nimbro_api/api/openai/base/chat_completions_base.py

@@ -131,7 +131,7 @@ class ChatCompletionsBase(ClientBase):
 
         # reasoning_effort
         assert_type_value(obj=settings['reasoning_effort'], type_or_value=str, name="setting 'reasoning_effort'")
-        valid_values = ["", "none", "minimal", "low", "medium", "high"]
+        valid_values = ["", "none", "minimal", "low", "medium", "high", "xhigh", "max"]
         assert_log(
             expression=settings['reasoning_effort'] in valid_values,
             message=f"Expected setting 'reasoning_effort' to be in {valid_values} but got '{settings['reasoning_effort']}'."
@@ -717,12 +717,11 @@ class ChatCompletionsBase(ClientBase):
 
     def generate_completion(self, response_type):
         # retrieve API key
-        try:
-            api_key = self.get_api_key()[2]
-        except UnrecoverableError as e:
+        success, message, api_key = self.get_api_key()
+        if not success:
             self._logger.debug("Restoring original context.")
             self.messages = self.context_dump
-            raise e
+            raise UnrecoverableError(message)
 
         # validate connection
         success, message = self.validate_connection(api_key=api_key)
@@ -1078,6 +1077,8 @@ class ChatCompletionsBase(ClientBase):
                 'HTTP-Referer': "https://github.com/ptzld/nimbro-api",
                 'X-Title': "NimbRo API"
             }
+            if api_key == "":
+                del headers['Authorization']
 
             if self._endpoint['api_flavor'] == "openai":
                 data = {
@@ -1094,7 +1095,7 @@ class ChatCompletionsBase(ClientBase):
                     'n': 1,
                     'stream': self._settings['stream']
                 }
-                if self._settings['reasoning_effort'] not in ["", "none"]:
+                if self._settings['reasoning_effort'] != "":
                     data['reasoning_effort'] = self._settings['reasoning_effort']
                 if len(self.tools) == 0:
                     del data['tools']
@@ -1118,6 +1119,10 @@ class ChatCompletionsBase(ClientBase):
                     'n': 1,
                     'stream': self._settings['stream']
                 }
+                if self._settings['reasoning_effort'] != "":
+                    data['reasoning_effort'] = self._settings['reasoning_effort']
+                if len(self.tools) > 0:
+                    data['parallel_tool_calls'] = self._settings['max_tool_calls'] is None or self._settings['max_tool_calls'] > 1
 
             elif self._endpoint['api_flavor'] == "openrouter":
                 data = {
@@ -1133,7 +1138,7 @@ class ChatCompletionsBase(ClientBase):
                     'n': 1,
                     'stream': self._settings['stream']
                 }
-                if self._settings['reasoning_effort'] not in ["", "none"]:
+                if self._settings['reasoning_effort'] != "":
                     data['reasoning'] = {
                         'effort': self._settings['reasoning_effort'],
                         'exclude': False
@@ -1665,7 +1670,7 @@ class ChatCompletionsBase(ClientBase):
 
         # error case: tool-choice "use specific function" was violated
         if len(self.tools) > 0 and response_type != "text" and response_type != "auto" and response_type != "always" and response_type != "json":
-            if text != "":
+            if text != "": # is text actually forbidden if the response still contains the demanded tool call?
                 is_valid = False
                 logs.append(f"Completion contains text content despite tool-choice being set to '{response_type}'.")
                 correction_messages[-1]['content'] = f"Your response must only contain a tool-call of '{response_type}' without additional text."
@@ -1764,8 +1769,7 @@ class ChatCompletionsBase(ClientBase):
                             logs.append(f"Completion contains a tool-call that violates the JSON Schema: {errors[0].message}")
                             reason = f"Your response contains a tool-call that violates the JSON Schema: {errors[0].message}"
                     else:
-                        logs.append("Tool-call cannot be validated against tool definitions because the 'jsonschema' module is not available.")
-                        self._logger.warn(logs[-1], once=True)
+                        self._logger.warn("Tool-call cannot be validated against tool definitions because the 'jsonschema' module is not available.", once=True)
 
         if success:
             self._logger.debug("Tool-call is valid.")