Skip to content

Commit 806d05f

Browse files
ivan-valkovivan-valkov
committed
Generate sdk
1 parent e67c779 commit 806d05f

File tree

91 files changed

+5852
-848
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+5852
-848
lines changed

‎python/README.md

+51-26
Large diffs are not rendered by default.

‎python/docs/AlertingServiceApi.md

+106
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# seldon_deploy_sdk.AlertingServiceApi
2+
3+
All URIs are relative to *https://X.X.X.X/seldon-deploy/api/v1alpha1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**alerting_service_list_alerts**](AlertingServiceApi.md#alerting_service_list_alerts) | **GET** /alerting/alerts | List currently firing alerts.
8+
[**alerting_service_trigger_test_alert**](AlertingServiceApi.md#alerting_service_trigger_test_alert) | **POST** /alerting/test | Triggers a test alert to check alerting workflow.
9+
10+
11+
# **alerting_service_list_alerts**
12+
> V1ListAlertsResponse alerting_service_list_alerts()
13+
14+
List currently firing alerts.
15+
16+
### Example
17+
```python
18+
from __future__ import print_function
19+
import time
20+
import seldon_deploy_sdk
21+
from seldon_deploy_sdk.rest import ApiException
22+
from pprint import pprint
23+
24+
# Configure OAuth2 access token for authorization: OAuth2
25+
configuration = seldon_deploy_sdk.Configuration()
26+
configuration.access_token = 'YOUR_ACCESS_TOKEN'
27+
28+
# create an instance of the API class
29+
api_instance = seldon_deploy_sdk.AlertingServiceApi(seldon_deploy_sdk.ApiClient(configuration))
30+
31+
try:
32+
# List currently firing alerts.
33+
api_response = api_instance.alerting_service_list_alerts()
34+
pprint(api_response)
35+
except ApiException as e:
36+
print("Exception when calling AlertingServiceApi->alerting_service_list_alerts: %s\n" % e)
37+
```
38+
39+
### Parameters
40+
This endpoint does not need any parameter.
41+
42+
### Return type
43+
44+
[**V1ListAlertsResponse**](V1ListAlertsResponse.md)
45+
46+
### Authorization
47+
48+
[OAuth2](../README.md#OAuth2)
49+
50+
### HTTP request headers
51+
52+
- **Content-Type**: application/json
53+
- **Accept**: application/json
54+
55+
[[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)
56+
57+
# **alerting_service_trigger_test_alert**
58+
> V1TriggerTestAlertResponse alerting_service_trigger_test_alert(body)
59+
60+
Triggers a test alert to check alerting workflow.
61+
62+
### Example
63+
```python
64+
from __future__ import print_function
65+
import time
66+
import seldon_deploy_sdk
67+
from seldon_deploy_sdk.rest import ApiException
68+
from pprint import pprint
69+
70+
# Configure OAuth2 access token for authorization: OAuth2
71+
configuration = seldon_deploy_sdk.Configuration()
72+
configuration.access_token = 'YOUR_ACCESS_TOKEN'
73+
74+
# create an instance of the API class
75+
api_instance = seldon_deploy_sdk.AlertingServiceApi(seldon_deploy_sdk.ApiClient(configuration))
76+
body = true # bool | Set to true if you wish to test Prometheus -> Alertmanager connection False sends an alert payload directly to Alertmanager, skipping Prometheus metrics/alert flow
77+
78+
try:
79+
# Triggers a test alert to check alerting workflow.
80+
api_response = api_instance.alerting_service_trigger_test_alert(body)
81+
pprint(api_response)
82+
except ApiException as e:
83+
print("Exception when calling AlertingServiceApi->alerting_service_trigger_test_alert: %s\n" % e)
84+
```
85+
86+
### Parameters
87+
88+
Name | Type | Description | Notes
89+
------------- | ------------- | ------------- | -------------
90+
**body** | **bool**| Set to true if you wish to test Prometheus -> Alertmanager connection False sends an alert payload directly to Alertmanager, skipping Prometheus metrics/alert flow |
91+
92+
### Return type
93+
94+
[**V1TriggerTestAlertResponse**](V1TriggerTestAlertResponse.md)
95+
96+
### Authorization
97+
98+
[OAuth2](../README.md#OAuth2)
99+
100+
### HTTP request headers
101+
102+
- **Content-Type**: application/json
103+
- **Accept**: application/json
104+
105+
[[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)
106+

‎python/docs/BatchJob.md ‎python/docs/BasicDetectorConfiguration.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
# BatchJob
1+
# BasicDetectorConfiguration
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**definition** | [**BatchDefinition**](BatchDefinition.md) | | [optional]
7-
**description** | [**BatchDescription**](BatchDescription.md) | | [optional]
6+
**drift_batch_size** | **str** | | [optional]
7+
**env_secret_ref** | **str** | | [optional]
8+
**storage_uri** | **str** | | [optional]
89

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

‎python/docs/BatchDefinition.md ‎python/docs/BatchJobDefinition.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
# BatchDefinition
1+
# BatchJobDefinition
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**batch_data_type** | **str** | Batch Data Type (data, json or str) | [optional]
77
**batch_gateway_endpoint** | **str** | Batch Gateway Endpoint | [optional]
88
**batch_gateway_type** | **str** | Batch Gateway Type (istio or seldon) | [optional]
9+
**batch_interval** | **float** | Size of the batch (number of predictions per request) | [optional]
910
**batch_method** | **str** | Batch Method (predict) | [optional]
1011
**batch_payload_type** | **str** | Batch Payload Type (ndarray, tensor, tftensor - only if DataType=data) | [optional]
1112
**batch_retries** | **str** | Number of retries for each instance | [optional]
13+
**batch_size** | **int** | Size of the batch (number of predictions per request) | [optional]
1214
**batch_transport_protocol** | **str** | Batch Transport Protocol (rest or grpc) | [optional]
1315
**batch_workers** | **str** | Number of batch workers | [optional]
1416
**input_data** | **str** | S3 URI of input data file | [optional]

‎python/docs/BatchDescription.md ‎python/docs/BatchJobDescription.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# BatchDescription
1+
# BatchJobDescription
22

33
## Properties
44
Name | Type | Description | Notes

‎python/docs/BatchJobDescriptionList.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# BatchJobDescriptionList
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
7+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
8+
9+

‎python/docs/BatchJobGetResponse.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# BatchJobGetResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**definition** | [**BatchJobDefinition**](BatchJobDefinition.md) | | [optional]
7+
**description** | [**BatchJobDescription**](BatchJobDescription.md) | | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎python/docs/BatchJobPostResponse.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# BatchJobPostResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**workflow_name** | **str** | Name of created Argo Workflow in: body | [optional]
7+
**workflow_uid** | [**UID**](UID.md) | | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎python/docs/BatchJobsApi.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Method | HTTP request | Description
1010

1111

1212
# **create_seldon_deployment_batch_job**
13-
> UID create_seldon_deployment_batch_job(name, namespace, workflow)
13+
> BatchJobPostResponse create_seldon_deployment_batch_job(name, namespace, workflow)
1414
1515

1616

@@ -32,7 +32,7 @@ configuration.access_token = 'YOUR_ACCESS_TOKEN'
3232
api_instance = seldon_deploy_sdk.BatchJobsApi(seldon_deploy_sdk.ApiClient(configuration))
3333
name = 'name_example' # str | Name identifies a resource
3434
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
35-
workflow = seldon_deploy_sdk.BatchDefinition() # BatchDefinition | WorkflowName
35+
workflow = seldon_deploy_sdk.BatchJobDefinition() # BatchJobDefinition | WorkflowName
3636

3737
try:
3838
api_response = api_instance.create_seldon_deployment_batch_job(name, namespace, workflow)
@@ -47,11 +47,11 @@ Name | Type | Description | Notes
4747
------------- | ------------- | ------------- | -------------
4848
**name** | **str**| Name identifies a resource |
4949
**namespace** | **str**| Namespace provides a logical grouping of resources |
50-
**workflow** | [**BatchDefinition**](BatchDefinition.md)| WorkflowName |
50+
**workflow** | [**BatchJobDefinition**](BatchJobDefinition.md)| WorkflowName |
5151

5252
### Return type
5353

54-
[**UID**](UID.md)
54+
[**BatchJobPostResponse**](BatchJobPostResponse.md)
5555

5656
### Authorization
5757

@@ -65,7 +65,7 @@ Name | Type | Description | Notes
6565
[[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)
6666

6767
# **get_deployment_batch_job**
68-
> BatchJob get_deployment_batch_job(name, namespace, job_name)
68+
> BatchJobGetResponse get_deployment_batch_job(name, namespace, job_name)
6969
7070

7171

@@ -106,7 +106,7 @@ Name | Type | Description | Notes
106106

107107
### Return type
108108

109-
[**BatchJob**](BatchJob.md)
109+
[**BatchJobGetResponse**](BatchJobGetResponse.md)
110110

111111
### Authorization
112112

@@ -120,7 +120,7 @@ Name | Type | Description | Notes
120120
[[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)
121121

122122
# **list_seldon_deployment_batch_jobs**
123-
> BatchDescriptionList list_seldon_deployment_batch_jobs(name, namespace, limit=limit, page=page)
123+
> BatchJobsListResponse list_seldon_deployment_batch_jobs(name, namespace, limit=limit, page=page)
124124
125125

126126

@@ -163,7 +163,7 @@ Name | Type | Description | Notes
163163

164164
### Return type
165165

166-
[**BatchDescriptionList**](BatchDescriptionList.md)
166+
[**BatchJobsListResponse**](BatchJobsListResponse.md)
167167

168168
### Authorization
169169

‎python/docs/BatchJobsListResponse.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# BatchJobsListResponse
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**batch_jobs** | [**BatchJobDescriptionList**](BatchJobDescriptionList.md) | | [optional]
7+
**limit** | **int** | Limit of the request in: body | [optional]
8+
**page** | **int** | Returned Page (counting from 0) in: body | [optional]
9+
**pages_count** | **int** | Number of available pages (Page = 0, ..., PagesCount - 1) in: body | [optional]
10+
11+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
12+
13+

‎python/docs/DeploymentFeatureData.md

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
1111
**filters** | [**list[FeatureFilter]**](FeatureFilter.md) | Filters is a set of time, feature and/or outlier filters for the distribution/stats query | [optional]
1212
**interaction** | [**FeatureInteraction**](FeatureInteraction.md) | | [optional]
1313
**parameters** | [**FeatureDistributionParameters**](FeatureDistributionParameters.md) | | [optional]
14+
**reference_data** | **bool** | ReferenceData is a boolean to compute stats and distributions over reference data or inference data (false by default) | [optional]
1415

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

‎python/docs/DetectorConfiguration.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# DetectorConfiguration
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**basic** | [**BasicDetectorConfiguration**](BasicDetectorConfiguration.md) | | [optional]
7+
**deployment** | [**DetectorDeploymentConfiguration**](DetectorDeploymentConfiguration.md) | | [optional]
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

‎python/docs/AlibiDetectorData.md ‎python/docs/DetectorData.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# AlibiDetectorData
1+
# DetectorData
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**deployment** | **str** | | [optional]
7-
**deployment_namespace** | **str** | | [optional]
6+
**config** | [**DetectorConfiguration**](DetectorConfiguration.md) | | [optional]
7+
**deployment_kind** | **str** | | [optional]
8+
**deployment_name** | **str** | | [optional]
9+
**detector_type** | **str** | | [optional]
10+
**name** | **str** | | [optional]
811
**namespace** | **str** | | [optional]
9-
**params** | [**AlibiDetectServerParams**](AlibiDetectServerParams.md) | | [optional]
10-
**prom_scraping** | **bool** | | [optional]
11-
**url** | **str** | | [optional]
1212

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

‎python/docs/AlibiDetectServerParams.md ‎python/docs/DetectorDeploymentConfiguration.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
1-
# AlibiDetectServerParams
1+
# DetectorDeploymentConfiguration
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**drift_batch_size** | **str** | | [optional]
7-
**env_secret_ref** | **str** | | [optional]
86
**event_source** | **str** | | [optional]
97
**event_type** | **str** | | [optional]
108
**http_port** | **str** | | [optional]
119
**model_name** | **str** | | [optional]
10+
**prom_scraping** | **bool** | | [optional]
1211
**protocol** | **str** | | [optional]
1312
**reply_url** | **str** | | [optional]
14-
**storage_uri** | **str** | | [optional]
1513
**user_permission** | **int** | | [optional]
1614

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

0 commit comments

Comments
 (0)