Skip to content

Commit e1fd3f7

Browse files
hotdata-automation[bot]github-actions[bot]
hotdata-automation[bot]
authored and
github-actions[bot]
committed
chore: regenerate client from OpenAPI spec
1 parent 1f0d15c commit e1fd3f7

9 files changed

Lines changed: 1585 additions & 99 deletions

File tree

‎.openapi-generator/FILES‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,4 @@ requirements.txt
287287
setup.cfg
288288
test-requirements.txt
289289
test/__init__.py
290-
test/test_dataset_source_one_of2.py
291-
test/test_dataset_source_one_of3.py
292-
test/test_dataset_source_one_of4.py
293290
tox.ini

‎docs/CreateIndexRequest.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
99
**var_async** | **bool** | When true, create the index as a background job and return a job ID for polling. | [optional]
1010
**columns** | **List[str]** | Columns to index. Required for all index types. |
1111
**description** | **str** | User-facing description of the embedding (e.g., \"product descriptions\"). | [optional]
12-
**dimensions** | **int** | Output vector dimensions. Some models support multiple dimension sizes (e.g., OpenAI text-embedding-3-small supports 512 or 1536). If omitted, the model's default dimensions are used. | [optional]
12+
**dimensions** | **int** | Output vector dimensions. Some models support multiple dimension sizes (e.g., OpenAI text-embedding-3-small supports 512 or 1536). If omitted, the model's default dimensions are used | [optional]
1313
**embedding_provider_id** | **str** | Embedding provider ID. When set for a vector index, the source column is treated as text and embeddings are generated automatically. The vector index is then built on the generated embedding column (`{column}_embedding` by default). | [optional]
1414
**index_name** | **str** | |
1515
**index_type** | **str** | Index type: \"sorted\" (default), \"bm25\", or \"vector\" | [optional]

‎docs/IndexesApi.md‎

Lines changed: 286 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,112 @@ All URIs are relative to *https://api.hotdata.dev*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**create_dataset_index**](IndexesApi.md#create_dataset_index) | **POST** /v1/datasets/{dataset_id}/indexes | Create an index on a dataset
78
[**create_index**](IndexesApi.md#create_index) | **POST** /v1/connections/{connection_id}/tables/{schema}/{table}/indexes | Create an index on a table
9+
[**delete_dataset_index**](IndexesApi.md#delete_dataset_index) | **DELETE** /v1/datasets/{dataset_id}/indexes/{index_name} | Delete a dataset index
810
[**delete_index**](IndexesApi.md#delete_index) | **DELETE** /v1/connections/{connection_id}/tables/{schema}/{table}/indexes/{index_name} | Delete an index
11+
[**list_dataset_indexes**](IndexesApi.md#list_dataset_indexes) | **GET** /v1/datasets/{dataset_id}/indexes | List indexes on a dataset
912
[**list_indexes**](IndexesApi.md#list_indexes) | **GET** /v1/connections/{connection_id}/tables/{schema}/{table}/indexes | List indexes on a table
1013

1114

15+
# **create_dataset_index**
16+
> IndexInfoResponse create_dataset_index(dataset_id, create_index_request)
17+
18+
Create an index on a dataset
19+
20+
Create a sorted, BM25, or vector index on a dataset.
21+
22+
### Example
23+
24+
* Api Key Authentication (WorkspaceId):
25+
* Api Key Authentication (SessionId):
26+
* Bearer Authentication (BearerAuth):
27+
28+
```python
29+
import hotdata
30+
from hotdata.models.create_index_request import CreateIndexRequest
31+
from hotdata.models.index_info_response import IndexInfoResponse
32+
from hotdata.rest import ApiException
33+
from pprint import pprint
34+
35+
# Defining the host is optional and defaults to https://api.hotdata.dev
36+
# See configuration.py for a list of all supported configuration parameters.
37+
configuration = hotdata.Configuration(
38+
host = "https://api.hotdata.dev"
39+
)
40+
41+
# The client must configure the authentication and authorization parameters
42+
# in accordance with the API server security policy.
43+
# Examples for each auth method are provided below, use the example that
44+
# satisfies your auth use case.
45+
46+
# Configure API key authorization: WorkspaceId
47+
configuration.api_key['WorkspaceId'] = os.environ["API_KEY"]
48+
49+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
50+
# configuration.api_key_prefix['WorkspaceId'] = 'Bearer'
51+
52+
# Configure API key authorization: SessionId
53+
configuration.api_key['SessionId'] = os.environ["API_KEY"]
54+
55+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
56+
# configuration.api_key_prefix['SessionId'] = 'Bearer'
57+
58+
# Configure Bearer authorization: BearerAuth
59+
configuration = hotdata.Configuration(
60+
access_token = os.environ["BEARER_TOKEN"]
61+
)
62+
63+
# Enter a context with an instance of the API client
64+
with hotdata.ApiClient(configuration) as api_client:
65+
# Create an instance of the API class
66+
api_instance = hotdata.IndexesApi(api_client)
67+
dataset_id = 'dataset_id_example' # str | Dataset identifier
68+
create_index_request = hotdata.CreateIndexRequest() # CreateIndexRequest |
69+
70+
try:
71+
# Create an index on a dataset
72+
api_response = api_instance.create_dataset_index(dataset_id, create_index_request)
73+
print("The response of IndexesApi->create_dataset_index:\n")
74+
pprint(api_response)
75+
except Exception as e:
76+
print("Exception when calling IndexesApi->create_dataset_index: %s\n" % e)
77+
```
78+
79+
80+
81+
### Parameters
82+
83+
84+
Name | Type | Description | Notes
85+
------------- | ------------- | ------------- | -------------
86+
**dataset_id** | **str**| Dataset identifier |
87+
**create_index_request** | [**CreateIndexRequest**](CreateIndexRequest.md)| |
88+
89+
### Return type
90+
91+
[**IndexInfoResponse**](IndexInfoResponse.md)
92+
93+
### Authorization
94+
95+
[WorkspaceId](../README.md#WorkspaceId), [SessionId](../README.md#SessionId), [BearerAuth](../README.md#BearerAuth)
96+
97+
### HTTP request headers
98+
99+
- **Content-Type**: application/json
100+
- **Accept**: application/json
101+
102+
### HTTP response details
103+
104+
| Status code | Description | Response headers |
105+
|-------------|-------------|------------------|
106+
**201** | Index created | - |
107+
**400** | Invalid request | - |
108+
**404** | Dataset not found | - |
109+
**500** | Internal server error | - |
110+
111+
[[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)
112+
12113
# **create_index**
13114
> IndexInfoResponse create_index(connection_id, var_schema, table, create_index_request)
14115
@@ -104,6 +205,98 @@ Name | Type | Description | Notes
104205

105206
[[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)
106207

208+
# **delete_dataset_index**
209+
> delete_dataset_index(dataset_id, index_name)
210+
211+
Delete a dataset index
212+
213+
Delete a specific index from a dataset.
214+
215+
### Example
216+
217+
* Api Key Authentication (WorkspaceId):
218+
* Api Key Authentication (SessionId):
219+
* Bearer Authentication (BearerAuth):
220+
221+
```python
222+
import hotdata
223+
from hotdata.rest import ApiException
224+
from pprint import pprint
225+
226+
# Defining the host is optional and defaults to https://api.hotdata.dev
227+
# See configuration.py for a list of all supported configuration parameters.
228+
configuration = hotdata.Configuration(
229+
host = "https://api.hotdata.dev"
230+
)
231+
232+
# The client must configure the authentication and authorization parameters
233+
# in accordance with the API server security policy.
234+
# Examples for each auth method are provided below, use the example that
235+
# satisfies your auth use case.
236+
237+
# Configure API key authorization: WorkspaceId
238+
configuration.api_key['WorkspaceId'] = os.environ["API_KEY"]
239+
240+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
241+
# configuration.api_key_prefix['WorkspaceId'] = 'Bearer'
242+
243+
# Configure API key authorization: SessionId
244+
configuration.api_key['SessionId'] = os.environ["API_KEY"]
245+
246+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
247+
# configuration.api_key_prefix['SessionId'] = 'Bearer'
248+
249+
# Configure Bearer authorization: BearerAuth
250+
configuration = hotdata.Configuration(
251+
access_token = os.environ["BEARER_TOKEN"]
252+
)
253+
254+
# Enter a context with an instance of the API client
255+
with hotdata.ApiClient(configuration) as api_client:
256+
# Create an instance of the API class
257+
api_instance = hotdata.IndexesApi(api_client)
258+
dataset_id = 'dataset_id_example' # str | Dataset identifier
259+
index_name = 'index_name_example' # str | Index name
260+
261+
try:
262+
# Delete a dataset index
263+
api_instance.delete_dataset_index(dataset_id, index_name)
264+
except Exception as e:
265+
print("Exception when calling IndexesApi->delete_dataset_index: %s\n" % e)
266+
```
267+
268+
269+
270+
### Parameters
271+
272+
273+
Name | Type | Description | Notes
274+
------------- | ------------- | ------------- | -------------
275+
**dataset_id** | **str**| Dataset identifier |
276+
**index_name** | **str**| Index name |
277+
278+
### Return type
279+
280+
void (empty response body)
281+
282+
### Authorization
283+
284+
[WorkspaceId](../README.md#WorkspaceId), [SessionId](../README.md#SessionId), [BearerAuth](../README.md#BearerAuth)
285+
286+
### HTTP request headers
287+
288+
- **Content-Type**: Not defined
289+
- **Accept**: application/json
290+
291+
### HTTP response details
292+
293+
| Status code | Description | Response headers |
294+
|-------------|-------------|------------------|
295+
**204** | Index deleted | - |
296+
**404** | Index or dataset not found | - |
297+
298+
[[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)
299+
107300
# **delete_index**
108301
> delete_index(connection_id, var_schema, table, index_name)
109302
@@ -194,6 +387,99 @@ void (empty response body)
194387

195388
[[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)
196389

390+
# **list_dataset_indexes**
391+
> ListIndexesResponse list_dataset_indexes(dataset_id)
392+
393+
List indexes on a dataset
394+
395+
List all indexes created on a dataset.
396+
397+
### Example
398+
399+
* Api Key Authentication (WorkspaceId):
400+
* Api Key Authentication (SessionId):
401+
* Bearer Authentication (BearerAuth):
402+
403+
```python
404+
import hotdata
405+
from hotdata.models.list_indexes_response import ListIndexesResponse
406+
from hotdata.rest import ApiException
407+
from pprint import pprint
408+
409+
# Defining the host is optional and defaults to https://api.hotdata.dev
410+
# See configuration.py for a list of all supported configuration parameters.
411+
configuration = hotdata.Configuration(
412+
host = "https://api.hotdata.dev"
413+
)
414+
415+
# The client must configure the authentication and authorization parameters
416+
# in accordance with the API server security policy.
417+
# Examples for each auth method are provided below, use the example that
418+
# satisfies your auth use case.
419+
420+
# Configure API key authorization: WorkspaceId
421+
configuration.api_key['WorkspaceId'] = os.environ["API_KEY"]
422+
423+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
424+
# configuration.api_key_prefix['WorkspaceId'] = 'Bearer'
425+
426+
# Configure API key authorization: SessionId
427+
configuration.api_key['SessionId'] = os.environ["API_KEY"]
428+
429+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
430+
# configuration.api_key_prefix['SessionId'] = 'Bearer'
431+
432+
# Configure Bearer authorization: BearerAuth
433+
configuration = hotdata.Configuration(
434+
access_token = os.environ["BEARER_TOKEN"]
435+
)
436+
437+
# Enter a context with an instance of the API client
438+
with hotdata.ApiClient(configuration) as api_client:
439+
# Create an instance of the API class
440+
api_instance = hotdata.IndexesApi(api_client)
441+
dataset_id = 'dataset_id_example' # str | Dataset identifier
442+
443+
try:
444+
# List indexes on a dataset
445+
api_response = api_instance.list_dataset_indexes(dataset_id)
446+
print("The response of IndexesApi->list_dataset_indexes:\n")
447+
pprint(api_response)
448+
except Exception as e:
449+
print("Exception when calling IndexesApi->list_dataset_indexes: %s\n" % e)
450+
```
451+
452+
453+
454+
### Parameters
455+
456+
457+
Name | Type | Description | Notes
458+
------------- | ------------- | ------------- | -------------
459+
**dataset_id** | **str**| Dataset identifier |
460+
461+
### Return type
462+
463+
[**ListIndexesResponse**](ListIndexesResponse.md)
464+
465+
### Authorization
466+
467+
[WorkspaceId](../README.md#WorkspaceId), [SessionId](../README.md#SessionId), [BearerAuth](../README.md#BearerAuth)
468+
469+
### HTTP request headers
470+
471+
- **Content-Type**: Not defined
472+
- **Accept**: application/json
473+
474+
### HTTP response details
475+
476+
| Status code | Description | Response headers |
477+
|-------------|-------------|------------------|
478+
**200** | Indexes listed | - |
479+
**404** | Dataset not found | - |
480+
481+
[[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)
482+
197483
# **list_indexes**
198484
> ListIndexesResponse list_indexes(connection_id, var_schema, table)
199485

‎docs/JobType.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Background job types returned by the API.
1414

1515
* `CREATE_INDEX` (value: `'create_index'`)
1616

17+
* `CREATE_DATASET_INDEX` (value: `'create_dataset_index'`)
18+
1719
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1820

1921

0 commit comments

Comments
 (0)