Skip to content

Commit a7cf9be

Browse files
author
brandon
committed
Merge branch 'main' into brandon/note_pinning
2 parents c1e6b54 + 648facb commit a7cf9be

21 files changed

+979
-25
lines changed

generated/.openapi-generator/FILES

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
.gitignore
22
README.md
3+
docs/AccountMonthToDateInfo.md
34
docs/Action.md
45
docs/ActionList.md
56
docs/ActionsApi.md
@@ -41,6 +42,7 @@ docs/LabelValue.md
4142
docs/LabelValueRequest.md
4243
docs/LabelsApi.md
4344
docs/ModeEnum.md
45+
docs/MonthToDateAccountInfoApi.md
4446
docs/MultiClassModeConfiguration.md
4547
docs/MultiClassificationResult.md
4648
docs/Note.md
@@ -77,13 +79,15 @@ groundlight_openapi_client/api/detectors_api.py
7779
groundlight_openapi_client/api/edge_api.py
7880
groundlight_openapi_client/api/image_queries_api.py
7981
groundlight_openapi_client/api/labels_api.py
82+
groundlight_openapi_client/api/month_to_date_account_info_api.py
8083
groundlight_openapi_client/api/notes_api.py
8184
groundlight_openapi_client/api/user_api.py
8285
groundlight_openapi_client/api_client.py
8386
groundlight_openapi_client/apis/__init__.py
8487
groundlight_openapi_client/configuration.py
8588
groundlight_openapi_client/exceptions.py
8689
groundlight_openapi_client/model/__init__.py
90+
groundlight_openapi_client/model/account_month_to_date_info.py
8791
groundlight_openapi_client/model/action.py
8892
groundlight_openapi_client/model/action_list.py
8993
groundlight_openapi_client/model/all_notes.py
@@ -150,6 +154,4 @@ setup.cfg
150154
setup.py
151155
test-requirements.txt
152156
test/__init__.py
153-
test/test_label.py
154-
test/test_source.py
155157
tox.ini

generated/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,13 +137,15 @@ Class | Method | HTTP request | Description
137137
*ImageQueriesApi* | [**list_image_queries**](docs/ImageQueriesApi.md#list_image_queries) | **GET** /v1/image-queries |
138138
*ImageQueriesApi* | [**submit_image_query**](docs/ImageQueriesApi.md#submit_image_query) | **POST** /v1/image-queries |
139139
*LabelsApi* | [**create_label**](docs/LabelsApi.md#create_label) | **POST** /v1/labels |
140+
*MonthToDateAccountInfoApi* | [**month_to_date_account_info**](docs/MonthToDateAccountInfoApi.md#month_to_date_account_info) | **GET** /v1/month-to-date-account-info |
140141
*NotesApi* | [**create_note**](docs/NotesApi.md#create_note) | **POST** /v1/notes |
141142
*NotesApi* | [**get_notes**](docs/NotesApi.md#get_notes) | **GET** /v1/notes |
142143
*UserApi* | [**who_am_i**](docs/UserApi.md#who_am_i) | **GET** /v1/me |
143144

144145

145146
## Documentation For Models
146147

148+
- [AccountMonthToDateInfo](docs/AccountMonthToDateInfo.md)
147149
- [Action](docs/Action.md)
148150
- [ActionList](docs/ActionList.md)
149151
- [AllNotes](docs/AllNotes.md)
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# AccountMonthToDateInfo
2+
3+
Account usage information for the current month
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**iqs** | **int** | The number of image queries in the current month. |
9+
**escalations** | **int** | The number of escalations in the current month. |
10+
**active_detectors** | **int** | The number of active detectors in the current month. |
11+
**iqs_limit** | **int, none_type** | The limit on the number of image queries in the current month. |
12+
**escalations_limit** | **int, none_type** | The limit on the number of escalations in the current month. |
13+
**active_detectors_limit** | **int, none_type** | The limit on the number of active detectors in the current month. |
14+
**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]
15+
16+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
17+
18+

generated/docs/ActionsApi.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,11 +396,12 @@ with groundlight_openapi_client.ApiClient(configuration) as api_client:
396396
api_instance = actions_api.ActionsApi(api_client)
397397
page = 1 # int | A page number within the paginated result set. (optional)
398398
page_size = 1 # int | Number of results to return per page. (optional)
399+
predictor_id = "predictor_id_example" # str | Filter rules by predictor ID (optional)
399400

400401
# example passing only required values which don't have defaults set
401402
# and optional values
402403
try:
403-
api_response = api_instance.list_rules(page=page, page_size=page_size)
404+
api_response = api_instance.list_rules(page=page, page_size=page_size, predictor_id=predictor_id)
404405
pprint(api_response)
405406
except groundlight_openapi_client.ApiException as e:
406407
print("Exception when calling ActionsApi->list_rules: %s\n" % e)
@@ -413,6 +414,7 @@ Name | Type | Description | Notes
413414
------------- | ------------- | ------------- | -------------
414415
**page** | **int**| A page number within the paginated result set. | [optional]
415416
**page_size** | **int**| Number of results to return per page. | [optional]
417+
**predictor_id** | **str**| Filter rules by predictor ID | [optional]
416418

417419
### Return type
418420

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# groundlight_openapi_client.MonthToDateAccountInfoApi
2+
3+
All URIs are relative to *https://api.groundlight.ai/device-api*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**month_to_date_account_info**](MonthToDateAccountInfoApi.md#month_to_date_account_info) | **GET** /v1/month-to-date-account-info |
8+
9+
10+
# **month_to_date_account_info**
11+
> AccountMonthToDateInfo month_to_date_account_info()
12+
13+
14+
15+
Fetches and returns the account-specific metrics based on the current user's group.
16+
17+
### Example
18+
19+
* Api Key Authentication (ApiToken):
20+
21+
```python
22+
import time
23+
import groundlight_openapi_client
24+
from groundlight_openapi_client.api import month_to_date_account_info_api
25+
from groundlight_openapi_client.model.account_month_to_date_info import AccountMonthToDateInfo
26+
from pprint import pprint
27+
# Defining the host is optional and defaults to https://api.groundlight.ai/device-api
28+
# See configuration.py for a list of all supported configuration parameters.
29+
configuration = groundlight_openapi_client.Configuration(
30+
host = "https://api.groundlight.ai/device-api"
31+
)
32+
33+
# The client must configure the authentication and authorization parameters
34+
# in accordance with the API server security policy.
35+
# Examples for each auth method are provided below, use the example that
36+
# satisfies your auth use case.
37+
38+
# Configure API key authorization: ApiToken
39+
configuration.api_key['ApiToken'] = 'YOUR_API_KEY'
40+
41+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
42+
# configuration.api_key_prefix['ApiToken'] = 'Bearer'
43+
44+
# Enter a context with an instance of the API client
45+
with groundlight_openapi_client.ApiClient(configuration) as api_client:
46+
# Create an instance of the API class
47+
api_instance = month_to_date_account_info_api.MonthToDateAccountInfoApi(api_client)
48+
49+
# example, this endpoint has no required or optional parameters
50+
try:
51+
api_response = api_instance.month_to_date_account_info()
52+
pprint(api_response)
53+
except groundlight_openapi_client.ApiException as e:
54+
print("Exception when calling MonthToDateAccountInfoApi->month_to_date_account_info: %s\n" % e)
55+
```
56+
57+
58+
### Parameters
59+
This endpoint does not need any parameter.
60+
61+
### Return type
62+
63+
[**AccountMonthToDateInfo**](AccountMonthToDateInfo.md)
64+
65+
### Authorization
66+
67+
[ApiToken](../README.md#ApiToken)
68+
69+
### HTTP request headers
70+
71+
- **Content-Type**: Not defined
72+
- **Accept**: application/json
73+
74+
75+
### HTTP response details
76+
77+
| Status code | Description | Response headers |
78+
|-------------|-------------|------------------|
79+
**200** | | - |
80+
81+
[[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)
82+

generated/docs/Source.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**value** | **str** | | must be one of ["STILL_PROCESSING", "CLOUD", "USER", "CLOUD_ENSEMBLE", "ALGORITHM", "EDGE", ]
7+
**value** | **str** | | must be one of ["STILL_PROCESSING", "CLOUD", "USER", "CLOUD_ENSEMBLE", "ALGORITHM", "AI_CLOUD", "AI_CLOUD_ENSEMBLE", "HUMAN_AI_CLOUD_ENSEMBLE", "EDGE", ]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

generated/docs/SourceEnum.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**value** | **str** | | must be one of ["INITIAL_PLACEHOLDER", "CLOUD", "CUST", "HUMAN_CLOUD_ENSEMBLE", "ALG", "ALG_REC", "ALG_UNCLEAR", "EDGE", ]
7+
**value** | **str** | | must be one of ["INITIAL_PLACEHOLDER", "CLOUD", "CUST", "HUMAN_CLOUD_ENSEMBLE", "AI_CLOUD", "AI_CLOUD_ENSEMBLE", "HUMAN_AI_CLOUD_ENSEMBLE", "ALG", "ALG_REC", "ALG_UNCLEAR", "EDGE", ]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

generated/groundlight_openapi_client/api/actions_api.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,7 @@ def __init__(self, api_client=None):
222222
"all": [
223223
"page",
224224
"page_size",
225+
"predictor_id",
225226
],
226227
"required": [],
227228
"nullable": [],
@@ -234,14 +235,17 @@ def __init__(self, api_client=None):
234235
"openapi_types": {
235236
"page": (int,),
236237
"page_size": (int,),
238+
"predictor_id": (str,),
237239
},
238240
"attribute_map": {
239241
"page": "page",
240242
"page_size": "page_size",
243+
"predictor_id": "predictor_id",
241244
},
242245
"location_map": {
243246
"page": "query",
244247
"page_size": "query",
248+
"predictor_id": "query",
245249
},
246250
"collection_format_map": {},
247251
},
@@ -502,6 +506,7 @@ def list_rules(self, **kwargs):
502506
Keyword Args:
503507
page (int): A page number within the paginated result set.. [optional]
504508
page_size (int): Number of results to return per page.. [optional]
509+
predictor_id (str): Filter rules by predictor ID. [optional]
505510
_return_http_data_only (bool): response data without head status
506511
code and headers. Default is True.
507512
_preload_content (bool): if False, the urllib3.HTTPResponse object
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
"""
2+
Groundlight API
3+
4+
Groundlight makes it simple to understand images. You can easily create computer vision detectors just by describing what you want to know using natural language. # noqa: E501
5+
6+
The version of the OpenAPI document: 0.18.2
7+
8+
Generated by: https://openapi-generator.tech
9+
"""
10+
11+
import re # noqa: F401
12+
import sys # noqa: F401
13+
14+
from groundlight_openapi_client.api_client import ApiClient, Endpoint as _Endpoint
15+
from groundlight_openapi_client.model_utils import ( # noqa: F401
16+
check_allowed_values,
17+
check_validations,
18+
date,
19+
datetime,
20+
file_type,
21+
none_type,
22+
validate_and_convert_types,
23+
)
24+
from groundlight_openapi_client.model.account_month_to_date_info import AccountMonthToDateInfo
25+
26+
27+
class MonthToDateAccountInfoApi(object):
28+
"""NOTE: This class is auto generated by OpenAPI Generator
29+
Ref: https://openapi-generator.tech
30+
31+
Do not edit the class manually.
32+
"""
33+
34+
def __init__(self, api_client=None):
35+
if api_client is None:
36+
api_client = ApiClient()
37+
self.api_client = api_client
38+
self.month_to_date_account_info_endpoint = _Endpoint(
39+
settings={
40+
"response_type": (AccountMonthToDateInfo,),
41+
"auth": ["ApiToken"],
42+
"endpoint_path": "/v1/month-to-date-account-info",
43+
"operation_id": "month_to_date_account_info",
44+
"http_method": "GET",
45+
"servers": None,
46+
},
47+
params_map={"all": [], "required": [], "nullable": [], "enum": [], "validation": []},
48+
root_map={
49+
"validations": {},
50+
"allowed_values": {},
51+
"openapi_types": {},
52+
"attribute_map": {},
53+
"location_map": {},
54+
"collection_format_map": {},
55+
},
56+
headers_map={
57+
"accept": ["application/json"],
58+
"content_type": [],
59+
},
60+
api_client=api_client,
61+
)
62+
63+
def month_to_date_account_info(self, **kwargs):
64+
"""month_to_date_account_info # noqa: E501
65+
66+
Fetches and returns the account-specific metrics based on the current user's group. # noqa: E501
67+
This method makes a synchronous HTTP request by default. To make an
68+
asynchronous HTTP request, please pass async_req=True
69+
70+
>>> thread = api.month_to_date_account_info(async_req=True)
71+
>>> result = thread.get()
72+
73+
74+
Keyword Args:
75+
_return_http_data_only (bool): response data without head status
76+
code and headers. Default is True.
77+
_preload_content (bool): if False, the urllib3.HTTPResponse object
78+
will be returned without reading/decoding response data.
79+
Default is True.
80+
_request_timeout (int/float/tuple): timeout setting for this request. If
81+
one number provided, it will be total request timeout. It can also
82+
be a pair (tuple) of (connection, read) timeouts.
83+
Default is None.
84+
_check_input_type (bool): specifies if type checking
85+
should be done one the data sent to the server.
86+
Default is True.
87+
_check_return_type (bool): specifies if type checking
88+
should be done one the data received from the server.
89+
Default is True.
90+
_spec_property_naming (bool): True if the variable names in the input data
91+
are serialized names, as specified in the OpenAPI document.
92+
False if the variable names in the input data
93+
are pythonic names, e.g. snake case (default)
94+
_content_type (str/None): force body content-type.
95+
Default is None and content-type will be predicted by allowed
96+
content-types and body.
97+
_host_index (int/None): specifies the index of the server
98+
that we want to use.
99+
Default is read from the configuration.
100+
async_req (bool): execute request asynchronously
101+
102+
Returns:
103+
AccountMonthToDateInfo
104+
If the method is called asynchronously, returns the request
105+
thread.
106+
"""
107+
kwargs["async_req"] = kwargs.get("async_req", False)
108+
kwargs["_return_http_data_only"] = kwargs.get("_return_http_data_only", True)
109+
kwargs["_preload_content"] = kwargs.get("_preload_content", True)
110+
kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
111+
kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
112+
kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
113+
kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
114+
kwargs["_content_type"] = kwargs.get("_content_type")
115+
kwargs["_host_index"] = kwargs.get("_host_index")
116+
return self.month_to_date_account_info_endpoint.call_with_http_info(**kwargs)

generated/groundlight_openapi_client/apis/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@
2020
from groundlight_openapi_client.api.edge_api import EdgeApi
2121
from groundlight_openapi_client.api.image_queries_api import ImageQueriesApi
2222
from groundlight_openapi_client.api.labels_api import LabelsApi
23+
from groundlight_openapi_client.api.month_to_date_account_info_api import MonthToDateAccountInfoApi
2324
from groundlight_openapi_client.api.notes_api import NotesApi
2425
from groundlight_openapi_client.api.user_api import UserApi

0 commit comments

Comments
 (0)