Skip to content

Commit 224240d

Browse files
c-fteixeiracentml-machine-user
c-fteixeira
and
centml-machine-user
authored
Update clients to latest platform release (4.9.7) (#82)
Co-authored-by: platform CI <automation@centml.ai>
1 parent 7420d8a commit 224240d

36 files changed

Lines changed: 1701 additions & 13 deletions

‎README.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
44
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
55

66
- API version: 0.1.0
7-
- Package version: 4.9.6
7+
- Package version: 4.9.7
88
- Generator version: 7.9.0
99
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1010

@@ -100,6 +100,7 @@ Class | Method | HTTP request | Description
100100
*EXTERNALApi* | [**create_cserve_v3_deployment_deployments_cserve_v3_post**](docs/EXTERNALApi.md#create_cserve_v3_deployment_deployments_cserve_v3_post) | **POST** /deployments/cserve_v3 | Create Cserve V3 Deployment
101101
*EXTERNALApi* | [**create_inference_deployment_deployments_inference_post**](docs/EXTERNALApi.md#create_inference_deployment_deployments_inference_post) | **POST** /deployments/inference | Create Inference Deployment
102102
*EXTERNALApi* | [**create_inference_v3_deployment_deployments_inference_v3_post**](docs/EXTERNALApi.md#create_inference_v3_deployment_deployments_inference_v3_post) | **POST** /deployments/inference_v3 | Create Inference V3 Deployment
103+
*EXTERNALApi* | [**create_job_deployment_deployments_job_post**](docs/EXTERNALApi.md#create_job_deployment_deployments_job_post) | **POST** /deployments/job | Create Job Deployment
103104
*EXTERNALApi* | [**create_new_organization_organizations_post**](docs/EXTERNALApi.md#create_new_organization_organizations_post) | **POST** /organizations | Create New Organization
104105
*EXTERNALApi* | [**delete_api_key_credentials_api_key_id_delete**](docs/EXTERNALApi.md#delete_api_key_credentials_api_key_id_delete) | **DELETE** /credentials/api-key/{id} | Delete Api Key
105106
*EXTERNALApi* | [**delete_user_vault_item_endpoint_user_vault_delete**](docs/EXTERNALApi.md#delete_user_vault_item_endpoint_user_vault_delete) | **DELETE** /user_vault | Delete User Vault Item Endpoint
@@ -122,6 +123,7 @@ Class | Method | HTTP request | Description
122123
*EXTERNALApi* | [**get_hardware_instances_hardware_instances_get**](docs/EXTERNALApi.md#get_hardware_instances_hardware_instances_get) | **GET** /hardware-instances | Get Hardware Instances
123124
*EXTERNALApi* | [**get_inference_deployment_deployments_inference_deployment_id_get**](docs/EXTERNALApi.md#get_inference_deployment_deployments_inference_deployment_id_get) | **GET** /deployments/inference/{deployment_id} | Get Inference Deployment
124125
*EXTERNALApi* | [**get_inference_v3_deployment_deployments_inference_v3_deployment_id_get**](docs/EXTERNALApi.md#get_inference_v3_deployment_deployments_inference_v3_deployment_id_get) | **GET** /deployments/inference_v3/{deployment_id} | Get Inference V3 Deployment
126+
*EXTERNALApi* | [**get_job_deployment_deployments_job_deployment_id_get**](docs/EXTERNALApi.md#get_job_deployment_deployments_job_deployment_id_get) | **GET** /deployments/job/{deployment_id} | Get Job Deployment
125127
*EXTERNALApi* | [**get_prebuilt_images_prebuilt_images_get**](docs/EXTERNALApi.md#get_prebuilt_images_prebuilt_images_get) | **GET** /prebuilt-images | Get Prebuilt Images
126128
*EXTERNALApi* | [**get_usage_daily_bills_get**](docs/EXTERNALApi.md#get_usage_daily_bills_get) | **GET** /daily_bills | Get Usage
127129
*EXTERNALApi* | [**get_usage_deployments_usage_deployment_id_get**](docs/EXTERNALApi.md#get_usage_deployments_usage_deployment_id_get) | **GET** /deployments/usage/{deployment_id} | Get Usage
@@ -149,6 +151,7 @@ Class | Method | HTTP request | Description
149151
- [CServeRecipeResponse](docs/CServeRecipeResponse.md)
150152
- [CServeV2Recipe](docs/CServeV2Recipe.md)
151153
- [ClusterCapacityResponse](docs/ClusterCapacityResponse.md)
154+
- [ConfigFileMount](docs/ConfigFileMount.md)
152155
- [CreateCServeV2DeploymentRequest](docs/CreateCServeV2DeploymentRequest.md)
153156
- [CreateCServeV2DeploymentResponse](docs/CreateCServeV2DeploymentResponse.md)
154157
- [CreateCServeV3DeploymentRequest](docs/CreateCServeV3DeploymentRequest.md)
@@ -158,6 +161,8 @@ Class | Method | HTTP request | Description
158161
- [CreateInferenceDeploymentRequest](docs/CreateInferenceDeploymentRequest.md)
159162
- [CreateInferenceDeploymentResponse](docs/CreateInferenceDeploymentResponse.md)
160163
- [CreateInferenceV3DeploymentRequest](docs/CreateInferenceV3DeploymentRequest.md)
164+
- [CreateJobDeploymentRequest](docs/CreateJobDeploymentRequest.md)
165+
- [CreateJobDeploymentResponse](docs/CreateJobDeploymentResponse.md)
161166
- [CreateOrganizationRequest](docs/CreateOrganizationRequest.md)
162167
- [CreateOrganizationResponse](docs/CreateOrganizationResponse.md)
163168
- [CreateUrlRequest](docs/CreateUrlRequest.md)
@@ -182,6 +187,7 @@ Class | Method | HTTP request | Description
182187
- [GetDeploymentUsageResponse](docs/GetDeploymentUsageResponse.md)
183188
- [GetInferenceDeploymentResponse](docs/GetInferenceDeploymentResponse.md)
184189
- [GetInferenceV3DeploymentResponse](docs/GetInferenceV3DeploymentResponse.md)
190+
- [GetJobDeploymentResponse](docs/GetJobDeploymentResponse.md)
185191
- [GpuTypeCapacity](docs/GpuTypeCapacity.md)
186192
- [HTTPValidationError](docs/HTTPValidationError.md)
187193
- [HardwareInstanceResponse](docs/HardwareInstanceResponse.md)

‎docs/ConfigFileMount.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# ConfigFileMount
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**filename** | **str** | |
9+
**mount_path** | **str** | |
10+
**content** | **str** | |
11+
12+
## Example
13+
14+
```python
15+
from platform_api_python_client.models.config_file_mount import ConfigFileMount
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of ConfigFileMount from a JSON string
20+
config_file_mount_instance = ConfigFileMount.from_json(json)
21+
# print the JSON string representation of the object
22+
print(ConfigFileMount.to_json())
23+
24+
# convert the object into a dict
25+
config_file_mount_dict = config_file_mount_instance.to_dict()
26+
# create an instance of ConfigFileMount from a dict
27+
config_file_mount_from_dict = ConfigFileMount.from_dict(config_file_mount_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

‎docs/CreateInferenceV3DeploymentRequest.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Name | Type | Description | Notes
2828
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
2929
**enable_logging** | **bool** | | [optional] [default to False]
3030
**session_affinity** | **bool** | Enable best-effort sticky routing via the &#x60;X-Session-Id&#x60; request header. Requests carrying the same header value land on the same pod, improving KV cache reuse for agentic workloads. Requests without the header are routed at random. Affinity is NOT durable: scaling, rollouts, restarts, or readiness-probe transitions will remap sessions to different pods. Do not use for irreplaceable in-pod state. | [optional] [default to False]
31+
**config_file** | [**ConfigFileMount**](ConfigFileMount.md) | | [optional]
3132

3233
## Example
3334

‎docs/CreateJobDeploymentRequest.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# CreateJobDeploymentRequest
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**name** | **str** | |
9+
**cluster_id** | **int** | |
10+
**hardware_instance_id** | **int** | |
11+
**user_annotations** | **Dict[str, str]** | | [optional]
12+
**image_url** | **str** | |
13+
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
14+
**env_vars** | **Dict[str, str]** | | [optional]
15+
**command** | **str** | | [optional]
16+
**completions** | **int** | | [optional] [default to 1]
17+
**parallelism** | **int** | | [optional] [default to 1]
18+
**enable_logging** | **bool** | | [optional] [default to True]
19+
20+
## Example
21+
22+
```python
23+
from platform_api_python_client.models.create_job_deployment_request import CreateJobDeploymentRequest
24+
25+
# TODO update the JSON string below
26+
json = "{}"
27+
# create an instance of CreateJobDeploymentRequest from a JSON string
28+
create_job_deployment_request_instance = CreateJobDeploymentRequest.from_json(json)
29+
# print the JSON string representation of the object
30+
print(CreateJobDeploymentRequest.to_json())
31+
32+
# convert the object into a dict
33+
create_job_deployment_request_dict = create_job_deployment_request_instance.to_dict()
34+
# create an instance of CreateJobDeploymentRequest from a dict
35+
create_job_deployment_request_from_dict = CreateJobDeploymentRequest.from_dict(create_job_deployment_request_dict)
36+
```
37+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
38+
39+

‎docs/CreateJobDeploymentResponse.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# CreateJobDeploymentResponse
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**id** | **int** | |
9+
**created_at** | **datetime** | |
10+
**endpoint_url** | **str** | |
11+
12+
## Example
13+
14+
```python
15+
from platform_api_python_client.models.create_job_deployment_response import CreateJobDeploymentResponse
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of CreateJobDeploymentResponse from a JSON string
20+
create_job_deployment_response_instance = CreateJobDeploymentResponse.from_json(json)
21+
# print the JSON string representation of the object
22+
print(CreateJobDeploymentResponse.to_json())
23+
24+
# convert the object into a dict
25+
create_job_deployment_response_dict = create_job_deployment_response_instance.to_dict()
26+
# create an instance of CreateJobDeploymentResponse from a dict
27+
create_job_deployment_response_from_dict = CreateJobDeploymentResponse.from_dict(create_job_deployment_response_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

‎docs/DeploymentResponse.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Name | Type | Description | Notes
3737
**original_command** | **str** | | [optional]
3838
**image_pull_secret_credentials** | [**ImagePullSecretCredentials**](ImagePullSecretCredentials.md) | | [optional]
3939
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
40+
**config_file** | [**ConfigFileMount**](ConfigFileMount.md) | | [optional]
4041

4142
## Example
4243

‎docs/DeploymentType.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@
2727

2828
* `RAG` (value: `'rag'`)
2929

30+
* `JOB` (value: `'job'`)
31+
3032
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
3133

3234

‎docs/EXTERNALApi.md‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Method | HTTP request | Description
1010
[**create_cserve_v3_deployment_deployments_cserve_v3_post**](EXTERNALApi.md#create_cserve_v3_deployment_deployments_cserve_v3_post) | **POST** /deployments/cserve_v3 | Create Cserve V3 Deployment
1111
[**create_inference_deployment_deployments_inference_post**](EXTERNALApi.md#create_inference_deployment_deployments_inference_post) | **POST** /deployments/inference | Create Inference Deployment
1212
[**create_inference_v3_deployment_deployments_inference_v3_post**](EXTERNALApi.md#create_inference_v3_deployment_deployments_inference_v3_post) | **POST** /deployments/inference_v3 | Create Inference V3 Deployment
13+
[**create_job_deployment_deployments_job_post**](EXTERNALApi.md#create_job_deployment_deployments_job_post) | **POST** /deployments/job | Create Job Deployment
1314
[**create_new_organization_organizations_post**](EXTERNALApi.md#create_new_organization_organizations_post) | **POST** /organizations | Create New Organization
1415
[**delete_api_key_credentials_api_key_id_delete**](EXTERNALApi.md#delete_api_key_credentials_api_key_id_delete) | **DELETE** /credentials/api-key/{id} | Delete Api Key
1516
[**delete_user_vault_item_endpoint_user_vault_delete**](EXTERNALApi.md#delete_user_vault_item_endpoint_user_vault_delete) | **DELETE** /user_vault | Delete User Vault Item Endpoint
@@ -32,6 +33,7 @@ Method | HTTP request | Description
3233
[**get_hardware_instances_hardware_instances_get**](EXTERNALApi.md#get_hardware_instances_hardware_instances_get) | **GET** /hardware-instances | Get Hardware Instances
3334
[**get_inference_deployment_deployments_inference_deployment_id_get**](EXTERNALApi.md#get_inference_deployment_deployments_inference_deployment_id_get) | **GET** /deployments/inference/{deployment_id} | Get Inference Deployment
3435
[**get_inference_v3_deployment_deployments_inference_v3_deployment_id_get**](EXTERNALApi.md#get_inference_v3_deployment_deployments_inference_v3_deployment_id_get) | **GET** /deployments/inference_v3/{deployment_id} | Get Inference V3 Deployment
36+
[**get_job_deployment_deployments_job_deployment_id_get**](EXTERNALApi.md#get_job_deployment_deployments_job_deployment_id_get) | **GET** /deployments/job/{deployment_id} | Get Job Deployment
3537
[**get_prebuilt_images_prebuilt_images_get**](EXTERNALApi.md#get_prebuilt_images_prebuilt_images_get) | **GET** /prebuilt-images | Get Prebuilt Images
3638
[**get_usage_daily_bills_get**](EXTERNALApi.md#get_usage_daily_bills_get) | **GET** /daily_bills | Get Usage
3739
[**get_usage_deployments_usage_deployment_id_get**](EXTERNALApi.md#get_usage_deployments_usage_deployment_id_get) | **GET** /deployments/usage/{deployment_id} | Get Usage
@@ -518,6 +520,84 @@ Name | Type | Description | Notes
518520

519521
[[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)
520522

523+
# **create_job_deployment_deployments_job_post**
524+
> CreateJobDeploymentResponse create_job_deployment_deployments_job_post(create_job_deployment_request)
525+
526+
Create Job Deployment
527+
528+
### Example
529+
530+
* Bearer Authentication (HTTPBearer):
531+
532+
```python
533+
import platform_api_python_client
534+
from platform_api_python_client.models.create_job_deployment_request import CreateJobDeploymentRequest
535+
from platform_api_python_client.models.create_job_deployment_response import CreateJobDeploymentResponse
536+
from platform_api_python_client.rest import ApiException
537+
from pprint import pprint
538+
539+
# Defining the host is optional and defaults to http://localhost
540+
# See configuration.py for a list of all supported configuration parameters.
541+
configuration = platform_api_python_client.Configuration(
542+
host = "http://localhost"
543+
)
544+
545+
# The client must configure the authentication and authorization parameters
546+
# in accordance with the API server security policy.
547+
# Examples for each auth method are provided below, use the example that
548+
# satisfies your auth use case.
549+
550+
# Configure Bearer authorization: HTTPBearer
551+
configuration = platform_api_python_client.Configuration(
552+
access_token = os.environ["BEARER_TOKEN"]
553+
)
554+
555+
# Enter a context with an instance of the API client
556+
with platform_api_python_client.ApiClient(configuration) as api_client:
557+
# Create an instance of the API class
558+
api_instance = platform_api_python_client.EXTERNALApi(api_client)
559+
create_job_deployment_request = platform_api_python_client.CreateJobDeploymentRequest() # CreateJobDeploymentRequest |
560+
561+
try:
562+
# Create Job Deployment
563+
api_response = api_instance.create_job_deployment_deployments_job_post(create_job_deployment_request)
564+
print("The response of EXTERNALApi->create_job_deployment_deployments_job_post:\n")
565+
pprint(api_response)
566+
except Exception as e:
567+
print("Exception when calling EXTERNALApi->create_job_deployment_deployments_job_post: %s\n" % e)
568+
```
569+
570+
571+
572+
### Parameters
573+
574+
575+
Name | Type | Description | Notes
576+
------------- | ------------- | ------------- | -------------
577+
**create_job_deployment_request** | [**CreateJobDeploymentRequest**](CreateJobDeploymentRequest.md)| |
578+
579+
### Return type
580+
581+
[**CreateJobDeploymentResponse**](CreateJobDeploymentResponse.md)
582+
583+
### Authorization
584+
585+
[HTTPBearer](../README.md#HTTPBearer)
586+
587+
### HTTP request headers
588+
589+
- **Content-Type**: application/json
590+
- **Accept**: application/json
591+
592+
### HTTP response details
593+
594+
| Status code | Description | Response headers |
595+
|-------------|-------------|------------------|
596+
**200** | Successful Response | - |
597+
**422** | Validation Error | - |
598+
599+
[[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)
600+
521601
# **create_new_organization_organizations_post**
522602
> CreateOrganizationResponse create_new_organization_organizations_post(create_organization_request)
523603
@@ -2242,6 +2322,83 @@ Name | Type | Description | Notes
22422322

22432323
[[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)
22442324

2325+
# **get_job_deployment_deployments_job_deployment_id_get**
2326+
> GetJobDeploymentResponse get_job_deployment_deployments_job_deployment_id_get(deployment_id)
2327+
2328+
Get Job Deployment
2329+
2330+
### Example
2331+
2332+
* Bearer Authentication (HTTPBearer):
2333+
2334+
```python
2335+
import platform_api_python_client
2336+
from platform_api_python_client.models.get_job_deployment_response import GetJobDeploymentResponse
2337+
from platform_api_python_client.rest import ApiException
2338+
from pprint import pprint
2339+
2340+
# Defining the host is optional and defaults to http://localhost
2341+
# See configuration.py for a list of all supported configuration parameters.
2342+
configuration = platform_api_python_client.Configuration(
2343+
host = "http://localhost"
2344+
)
2345+
2346+
# The client must configure the authentication and authorization parameters
2347+
# in accordance with the API server security policy.
2348+
# Examples for each auth method are provided below, use the example that
2349+
# satisfies your auth use case.
2350+
2351+
# Configure Bearer authorization: HTTPBearer
2352+
configuration = platform_api_python_client.Configuration(
2353+
access_token = os.environ["BEARER_TOKEN"]
2354+
)
2355+
2356+
# Enter a context with an instance of the API client
2357+
with platform_api_python_client.ApiClient(configuration) as api_client:
2358+
# Create an instance of the API class
2359+
api_instance = platform_api_python_client.EXTERNALApi(api_client)
2360+
deployment_id = 56 # int |
2361+
2362+
try:
2363+
# Get Job Deployment
2364+
api_response = api_instance.get_job_deployment_deployments_job_deployment_id_get(deployment_id)
2365+
print("The response of EXTERNALApi->get_job_deployment_deployments_job_deployment_id_get:\n")
2366+
pprint(api_response)
2367+
except Exception as e:
2368+
print("Exception when calling EXTERNALApi->get_job_deployment_deployments_job_deployment_id_get: %s\n" % e)
2369+
```
2370+
2371+
2372+
2373+
### Parameters
2374+
2375+
2376+
Name | Type | Description | Notes
2377+
------------- | ------------- | ------------- | -------------
2378+
**deployment_id** | **int**| |
2379+
2380+
### Return type
2381+
2382+
[**GetJobDeploymentResponse**](GetJobDeploymentResponse.md)
2383+
2384+
### Authorization
2385+
2386+
[HTTPBearer](../README.md#HTTPBearer)
2387+
2388+
### HTTP request headers
2389+
2390+
- **Content-Type**: Not defined
2391+
- **Accept**: application/json
2392+
2393+
### HTTP response details
2394+
2395+
| Status code | Description | Response headers |
2396+
|-------------|-------------|------------------|
2397+
**200** | Successful Response | - |
2398+
**422** | Validation Error | - |
2399+
2400+
[[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)
2401+
22452402
# **get_prebuilt_images_prebuilt_images_get**
22462403
> ListPrebuiltImageResponse get_prebuilt_images_prebuilt_images_get(type=type)
22472404

‎docs/GetInferenceV3DeploymentResponse.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Name | Type | Description | Notes
3434
**backend_protocol** | [**BackendProtocol**](BackendProtocol.md) | | [optional]
3535
**enable_logging** | **bool** | | [optional] [default to True]
3636
**session_affinity** | **bool** | Enable best-effort sticky routing via the &#x60;X-Session-Id&#x60; request header. Requests carrying the same header value land on the same pod, improving KV cache reuse for agentic workloads. Requests without the header are routed at random. Affinity is NOT durable: scaling, rollouts, restarts, or readiness-probe transitions will remap sessions to different pods. Do not use for irreplaceable in-pod state. | [optional] [default to False]
37+
**config_file** | [**ConfigFileMount**](ConfigFileMount.md) | | [optional]
3738

3839
## Example
3940

0 commit comments

Comments
 (0)