Add "config_name" option (#11)

* Add config_name and generate code

* Enable more tests

* Add confidence_threshold

* Nullable config_name

* Update readme

* Bump version 0.4.0

Author: michael-groundlight

.gitignore

@@ -161,3 +161,5 @@ cython_debug/
 
 # This is a library, so we want clients to have more flexible dependencies. So we don't include a lockfile.
 poetry.lock
+
+node_modules/

Makefile

@@ -2,12 +2,10 @@
 
 install:  ## Install the package from source
 	poetry install
+	npm install
 
-# Java weirdness - see https://github.com/OpenAPITools/openapi-generator/issues/11763#issuecomment-1098337960
 generate: install  ## Generate the SDK from our public openapi spec
-	_JAVA_OPTIONS="--add-opens=java.base/java.lang=ALL-UNNAMED \
-	--add-opens=java.base/java.util=ALL-UNNAMED" \
-		openapi-generator generate -i spec/public-api.yaml \
+	node_modules/.bin/openapi-generator-cli generate -i spec/public-api.yaml \
 		-g python \
 		-o ./generated
 	poetry run datamodel-codegen  --input spec/public-api.yaml --output generated/model.py

README.md

@@ -24,6 +24,12 @@ from groundlight import Groundlight
 # gl = Groundlight(endpoint="https://device.integ.groundlight.ai/device-api")
 gl = Groundlight(api_token="<YOUR_API_TOKEN>")
 
+# Create a detector
+detector = gl.create_detector(name="Dog", query="Is it a dog?")
+
+# (Or, create a detector with a specific named ML config from https://github.com/positronix-ai/zuuul/blob/main/pysrc/predictor_config/binary_classification_predictors.yaml)
+# detector = gl.create_detector(name="Dog", query="Is it a dog?", config_name="b4mu11-mlp")
+
 # Call an API method (e.g., retrieve a list of detectors)
 detectors = gl.list_detectors()
 ```

generated/README.md

@@ -53,10 +53,10 @@ from openapi_client.api import detectors_api
 from openapi_client.model.detector import Detector
 from openapi_client.model.detector_creation_input import DetectorCreationInput
 from openapi_client.model.paginated_detector_list import PaginatedDetectorList
-# Defining the host is optional and defaults to https://device.positronix.ai/device-api
+# Defining the host is optional and defaults to https://api.groundlight.ai/device-api
 # See configuration.py for a list of all supported configuration parameters.
 configuration = openapi_client.Configuration(
-    host = "https://device.positronix.ai/device-api"
+    host = "https://api.groundlight.ai/device-api"
 )
 
 # The client must configure the authentication and authorization parameters
@@ -80,6 +80,7 @@ with openapi_client.ApiClient(configuration) as api_client:
         query="query_example",
         group_name="group_name_example",
         confidence_threshold=0.9,
+        config_name="config_name_example",
     ) # DetectorCreationInput | 
 
     try:
@@ -91,7 +92,7 @@ with openapi_client.ApiClient(configuration) as api_client:
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://device.positronix.ai/device-api*
+All URIs are relative to *https://api.groundlight.ai/device-api*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------

generated/docs/DetectorCreationInput.md

@@ -9,6 +9,7 @@ Name | Type | Description | Notes
 **query** | **str** | A question about the image. | 
 **group_name** | **str** | Which group should this detector be part of? | [optional] 
 **confidence_threshold** | **float** | If the detector's prediction is below this confidence threshold, send the image query for human review. | [optional]  if omitted the server will use the default value of 0.9
+**config_name** | **str, none_type** | (Advanced usage) If your account has multiple named ML configuration options enabled, you can use this field to specify which one you would like to use. | [optional] 
 **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

generated/docs/DetectorsApi.md

@@ -1,6 +1,6 @@
 # openapi_client.DetectorsApi
 
-All URIs are relative to *https://device.positronix.ai/device-api*
+All URIs are relative to *https://api.groundlight.ai/device-api*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -27,10 +27,10 @@ from openapi_client.api import detectors_api
 from openapi_client.model.detector_creation_input import DetectorCreationInput
 from openapi_client.model.detector import Detector
 from pprint import pprint
-# Defining the host is optional and defaults to https://device.positronix.ai/device-api
+# Defining the host is optional and defaults to https://api.groundlight.ai/device-api
 # See configuration.py for a list of all supported configuration parameters.
 configuration = openapi_client.Configuration(
-    host = "https://device.positronix.ai/device-api"
+    host = "https://api.groundlight.ai/device-api"
 )
 
 # The client must configure the authentication and authorization parameters
@@ -53,6 +53,7 @@ with openapi_client.ApiClient(configuration) as api_client:
         query="query_example",
         group_name="group_name_example",
         confidence_threshold=0.9,
+        config_name="config_name_example",
     ) # DetectorCreationInput | 
 
     # example passing only required values which don't have defaults set
@@ -109,10 +110,10 @@ import openapi_client
 from openapi_client.api import detectors_api
 from openapi_client.model.detector import Detector
 from pprint import pprint
-# Defining the host is optional and defaults to https://device.positronix.ai/device-api
+# Defining the host is optional and defaults to https://api.groundlight.ai/device-api
 # See configuration.py for a list of all supported configuration parameters.
 configuration = openapi_client.Configuration(
-    host = "https://device.positronix.ai/device-api"
+    host = "https://api.groundlight.ai/device-api"
 )
 
 # The client must configure the authentication and authorization parameters
@@ -186,10 +187,10 @@ import openapi_client
 from openapi_client.api import detectors_api
 from openapi_client.model.paginated_detector_list import PaginatedDetectorList
 from pprint import pprint
-# Defining the host is optional and defaults to https://device.positronix.ai/device-api
+# Defining the host is optional and defaults to https://api.groundlight.ai/device-api
 # See configuration.py for a list of all supported configuration parameters.
 configuration = openapi_client.Configuration(
-    host = "https://device.positronix.ai/device-api"
+    host = "https://api.groundlight.ai/device-api"
 )
 
 # The client must configure the authentication and authorization parameters

generated/docs/ImageQueriesApi.md

@@ -1,12 +1,12 @@
 # openapi_client.ImageQueriesApi
 
-All URIs are relative to *https://device.positronix.ai/device-api*
+All URIs are relative to *https://api.groundlight.ai/device-api*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_image_query**](ImageQueriesApi.md#get_image_query) | **GET** /v1/image-queries/{id} |
-[**list_image_queries**](ImageQueriesApi.md#list_image_queries) | **GET** /v1/image-queries |
-[**submit_image_query**](ImageQueriesApi.md#submit_image_query) | **POST** /v1/image-queries |
+[**get_image_query**](ImageQueriesApi.md#get_image_query) | **GET** /v1/image-queries/{id} | 
+[**list_image_queries**](ImageQueriesApi.md#list_image_queries) | **GET** /v1/image-queries | 
+[**submit_image_query**](ImageQueriesApi.md#submit_image_query) | **POST** /v1/image-queries | 
 
 
 # **get_image_query**
@@ -26,10 +26,10 @@ import openapi_client
 from openapi_client.api import image_queries_api
 from openapi_client.model.image_query import ImageQuery
 from pprint import pprint
-# Defining the host is optional and defaults to https://device.positronix.ai/device-api
+# Defining the host is optional and defaults to https://api.groundlight.ai/device-api
 # See configuration.py for a list of all supported configuration parameters.
 configuration = openapi_client.Configuration(
-    host = "https://device.positronix.ai/device-api"
+    host = "https://api.groundlight.ai/device-api"
 )
 
 # The client must configure the authentication and authorization parameters
@@ -103,10 +103,10 @@ import openapi_client
 from openapi_client.api import image_queries_api
 from openapi_client.model.paginated_image_query_list import PaginatedImageQueryList
 from pprint import pprint
-# Defining the host is optional and defaults to https://device.positronix.ai/device-api
+# Defining the host is optional and defaults to https://api.groundlight.ai/device-api
 # See configuration.py for a list of all supported configuration parameters.
 configuration = openapi_client.Configuration(
-    host = "https://device.positronix.ai/device-api"
+    host = "https://api.groundlight.ai/device-api"
 )
 
 # The client must configure the authentication and authorization parameters
@@ -171,7 +171,7 @@ Name | Type | Description  | Notes
 
 
 
- Submit an image query against a detector.  You must use `\"Content-Type: image/jpeg\"` for the image data. For example:  ```Bash $ curl https://api.groundlight.ai/device-api/v1/image-queries?detector_id=det_abc123 \\     --header \"Content-Type: image/jpeg\" \\     --data-binary @path/to/filename.jpeg ```
+ Submit an image query against a detector.  You must use `\"Content-Type: image/jpeg\"` for the image data. For example:  ```Bash $ curl https://api.groundlight.ai/device-api/v1/image-queries?detector_id=det_abc123 \\     --header \"Content-Type: image/jpeg\" \\     --data-binary @path/to/filename.jpeg ```  
 
 ### Example
 
@@ -183,10 +183,10 @@ import openapi_client
 from openapi_client.api import image_queries_api
 from openapi_client.model.image_query import ImageQuery
 from pprint import pprint
-# Defining the host is optional and defaults to https://device.positronix.ai/device-api
+# Defining the host is optional and defaults to https://api.groundlight.ai/device-api
 # See configuration.py for a list of all supported configuration parameters.
 configuration = openapi_client.Configuration(
-    host = "https://device.positronix.ai/device-api"
+    host = "https://api.groundlight.ai/device-api"
 )
 
 # The client must configure the authentication and authorization parameters
@@ -252,3 +252,4 @@ Name | Type | Description  | Notes
 **201** |  |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

generated/model.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  public-api.yaml
-#   timestamp: 2022-05-08T05:27:06+00:00
+#   timestamp: 2022-07-30T20:30:21+00:00
 
 from __future__ import annotations
 
@@ -33,6 +33,10 @@ class DetectorCreationInput(BaseModel):
         0.9,
         description="If the detector's prediction is below this confidence threshold, send the image query for human review.",
     )
+    config_name: Optional[constr(max_length=100)] = Field(
+        None,
+        description='(Advanced usage) If your account has multiple named ML configuration options enabled, you can use this field to specify which one you would like to use.',
+    )
 
 
 class DetectorTypeEnum(Enum):

generated/openapi_client/api/image_queries_api.py

@@ -360,7 +360,7 @@ def submit_image_query(
     ):
         """submit_image_query  # noqa: E501
 
-         Submit an image query against a detector.  You must use `\"Content-Type: image/jpeg\"` for the image data. For example:  ```Bash $ curl https://api.groundlight.ai/v1/image-queries?detector_id=det_abc123 \\     --header \"Content-Type: image/jpeg\" \\     --data-binary @path/to/filename.jpeg ```    # noqa: E501
+         Submit an image query against a detector.  You must use `\"Content-Type: image/jpeg\"` for the image data. For example:  ```Bash $ curl https://api.groundlight.ai/device-api/v1/image-queries?detector_id=det_abc123 \\     --header \"Content-Type: image/jpeg\" \\     --data-binary @path/to/filename.jpeg ```    # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

generated/openapi_client/configuration.py

@@ -113,7 +113,7 @@ def __init__(self, host=None,
                  ):
         """Constructor
         """
-        self._base_path = "https://device.positronix.ai/device-api" if host is None else host
+        self._base_path = "https://api.groundlight.ai/device-api" if host is None else host
         """Default Base url
         """
         self.server_index = 0 if server_index is None and host is None else server_index
@@ -420,20 +420,20 @@ def get_host_settings(self):
         """
         return [
             {
-                'url': "https://device.positronix.ai/device-api",
-                'description': "Device Prod",
+                'url': "https://api.groundlight.ai/device-api",
+                'description': "Prod",
             },
             {
-                'url': "https://device.integ.positronix.ai/device-api",
-                'description': "Device Integ",
+                'url': "https://api.integ.groundlight.ai/device-api",
+                'description': "Integ",
             },
             {
-                'url': "https://api.groundlight.ai",
-                'description': "Prod",
+                'url': "https://device.positronix.ai/device-api",
+                'description': "Device Prod",
             },
             {
-                'url': "https://api.integ.groundlight.ai",
-                'description': "Integ",
+                'url': "https://device.integ.positronix.ai/device-api",
+                'description': "Device Integ",
             }
         ]