Skip to content

Commit 8aace83

Browse files
feat(sdk): v4.12.0 - Auto-generated from unified API spec
Generated from unified API spec v4.12.0 Changes: - Auto-generated SDK updates This PR was automatically created by the API generation pipeline.
1 parent e0cf556 commit 8aace83

File tree

837 files changed

+20359
-1310
lines changed

Some content is hidden

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

837 files changed

+20359
-1310
lines changed

.openapi-generator/FILES

Lines changed: 132 additions & 6 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 71 additions & 4 deletions
Large diffs are not rendered by default.

docs/AIOrchestrationsApi.md

Lines changed: 796 additions & 0 deletions
Large diffs are not rendered by default.

docs/AISkillsApi.md

Lines changed: 980 additions & 0 deletions
Large diffs are not rendered by default.

docs/AIToolsApi.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All URIs are relative to *https://dashboard.quantcdn.io*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**get_ai_orchestration_status**](AIToolsApi.md#get_ai_orchestration_status) | **GET** /api/v3/organizations/{organisation}/ai/tools/orchestrations/{orchestrationId} | Get Orchestration Status
7+
[**get_ai_orchestration_status**](AIToolsApi.md#get_ai_orchestration_status) | **GET** /api/v3/organizations/{organisation}/ai/tools/orchestrations/{orchestrationId} | Get Tool Orchestration Status (Async Tool Polling)
88
[**get_ai_tool_execution_status**](AIToolsApi.md#get_ai_tool_execution_status) | **GET** /api/v3/organizations/{organisation}/ai/tools/executions/{executionId} | Get async tool execution status and result
99
[**list_ai_tool_executions**](AIToolsApi.md#list_ai_tool_executions) | **GET** /api/v3/organizations/{organisation}/ai/tools/executions | List tool executions for monitoring and debugging
1010
[**list_ai_tool_names**](AIToolsApi.md#list_ai_tool_names) | **GET** /api/v3/organizations/{organisation}/ai/tools/names | List tool names only (lightweight response)
@@ -14,9 +14,12 @@ Method | HTTP request | Description
1414
# **get_ai_orchestration_status**
1515
> GetAIOrchestrationStatus200Response get_ai_orchestration_status(organisation, orchestration_id)
1616
17-
Get Orchestration Status
17+
Get Tool Orchestration Status (Async Tool Polling)
1818

19-
Retrieves the status and synthesized result of a multi-tool orchestration.
19+
Retrieves the status and synthesized result of a multi-tool async execution orchestration.
20+
*
21+
* **Note:** This endpoint is for async tool execution polling (`/tools/orchestrations`).
22+
* For durable batch processing orchestrations, see `GET /orchestrations` endpoints.
2023
*
2124
* **Orchestration Pattern:**
2225
* When the AI requests multiple async tools simultaneously, an orchestration is created
@@ -80,7 +83,7 @@ with quantcdn.ApiClient(configuration) as api_client:
8083
orchestration_id = 'orch_abc123def456789012345678901234' # str | Orchestration identifier for aggregated async tool executions
8184

8285
try:
83-
# Get Orchestration Status
86+
# Get Tool Orchestration Status (Async Tool Polling)
8487
api_response = api_instance.get_ai_orchestration_status(organisation, orchestration_id)
8588
print("The response of AIToolsApi->get_ai_orchestration_status:\n")
8689
pprint(api_response)

docs/AIVectorDatabaseApi.md

Lines changed: 102 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**create_vector_collection**](AIVectorDatabaseApi.md#create_vector_collection) | **POST** /api/v3/organizations/{organisation}/ai/vector-db/collections | Create Vector Database Collection
88
[**delete_vector_collection**](AIVectorDatabaseApi.md#delete_vector_collection) | **DELETE** /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId} | Delete Collection
9+
[**delete_vector_documents**](AIVectorDatabaseApi.md#delete_vector_documents) | **DELETE** /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId}/documents | Delete Documents from Collection
910
[**get_vector_collection**](AIVectorDatabaseApi.md#get_vector_collection) | **GET** /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId} | Get Collection Details
1011
[**list_vector_collections**](AIVectorDatabaseApi.md#list_vector_collections) | **GET** /api/v3/organizations/{organisation}/ai/vector-db/collections | List Vector Database Collections
1112
[**query_vector_collection**](AIVectorDatabaseApi.md#query_vector_collection) | **POST** /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId}/query | Semantic Search Query
@@ -104,7 +105,7 @@ Name | Type | Description | Notes
104105
[[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)
105106

106107
# **delete_vector_collection**
107-
> DeleteVectorCollection200Response delete_vector_collection(organisation, collection_id)
108+
> DeleteSkillCollection200Response delete_vector_collection(organisation, collection_id)
108109
109110
Delete Collection
110111

@@ -116,7 +117,7 @@ Deletes a vector database collection and all its documents. This action cannot b
116117

117118
```python
118119
import quantcdn
119-
from quantcdn.models.delete_vector_collection200_response import DeleteVectorCollection200Response
120+
from quantcdn.models.delete_skill_collection200_response import DeleteSkillCollection200Response
120121
from quantcdn.rest import ApiException
121122
from pprint import pprint
122123

@@ -164,7 +165,7 @@ Name | Type | Description | Notes
164165

165166
### Return type
166167

167-
[**DeleteVectorCollection200Response**](DeleteVectorCollection200Response.md)
168+
[**DeleteSkillCollection200Response**](DeleteSkillCollection200Response.md)
168169

169170
### Authorization
170171

@@ -186,6 +187,104 @@ Name | Type | Description | Notes
186187

187188
[[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)
188189

190+
# **delete_vector_documents**
191+
> DeleteVectorDocuments200Response delete_vector_documents(organisation, collection_id, delete_vector_documents_request)
192+
193+
Delete Documents from Collection
194+
195+
Delete documents from a collection. Supports three deletion modes:
196+
*
197+
* 1. **Purge All** - Set `purgeAll: true` to delete ALL documents in the collection
198+
*
199+
* 2. **By Document IDs** - Provide `documentIds` array with specific document UUIDs
200+
*
201+
* 3. **By Metadata** - Provide `metadata` object with `field` and `values` to delete documents where the metadata field matches any of the values
202+
*
203+
* **Drupal Integration:**
204+
* When using with Drupal AI Search, use metadata deletion with:
205+
* - `field: 'drupal_entity_id'` to delete all chunks for specific entities
206+
* - `field: 'drupal_long_id'` to delete specific chunks
207+
208+
### Example
209+
210+
* Bearer (JWT) Authentication (BearerAuth):
211+
212+
```python
213+
import quantcdn
214+
from quantcdn.models.delete_vector_documents200_response import DeleteVectorDocuments200Response
215+
from quantcdn.models.delete_vector_documents_request import DeleteVectorDocumentsRequest
216+
from quantcdn.rest import ApiException
217+
from pprint import pprint
218+
219+
# Defining the host is optional and defaults to https://dashboard.quantcdn.io
220+
# See configuration.py for a list of all supported configuration parameters.
221+
configuration = quantcdn.Configuration(
222+
host = "https://dashboard.quantcdn.io"
223+
)
224+
225+
# The client must configure the authentication and authorization parameters
226+
# in accordance with the API server security policy.
227+
# Examples for each auth method are provided below, use the example that
228+
# satisfies your auth use case.
229+
230+
# Configure Bearer authorization (JWT): BearerAuth
231+
configuration = quantcdn.Configuration(
232+
access_token = os.environ["BEARER_TOKEN"]
233+
)
234+
235+
# Enter a context with an instance of the API client
236+
with quantcdn.ApiClient(configuration) as api_client:
237+
# Create an instance of the API class
238+
api_instance = quantcdn.AIVectorDatabaseApi(api_client)
239+
organisation = 'organisation_example' # str | Organisation machine name
240+
collection_id = 'collection_id_example' # str | Collection UUID
241+
delete_vector_documents_request = quantcdn.DeleteVectorDocumentsRequest() # DeleteVectorDocumentsRequest |
242+
243+
try:
244+
# Delete Documents from Collection
245+
api_response = api_instance.delete_vector_documents(organisation, collection_id, delete_vector_documents_request)
246+
print("The response of AIVectorDatabaseApi->delete_vector_documents:\n")
247+
pprint(api_response)
248+
except Exception as e:
249+
print("Exception when calling AIVectorDatabaseApi->delete_vector_documents: %s\n" % e)
250+
```
251+
252+
253+
254+
### Parameters
255+
256+
257+
Name | Type | Description | Notes
258+
------------- | ------------- | ------------- | -------------
259+
**organisation** | **str**| Organisation machine name |
260+
**collection_id** | **str**| Collection UUID |
261+
**delete_vector_documents_request** | [**DeleteVectorDocumentsRequest**](DeleteVectorDocumentsRequest.md)| |
262+
263+
### Return type
264+
265+
[**DeleteVectorDocuments200Response**](DeleteVectorDocuments200Response.md)
266+
267+
### Authorization
268+
269+
[BearerAuth](../README.md#BearerAuth)
270+
271+
### HTTP request headers
272+
273+
- **Content-Type**: application/json
274+
- **Accept**: application/json
275+
276+
### HTTP response details
277+
278+
| Status code | Description | Response headers |
279+
|-------------|-------------|------------------|
280+
**200** | Documents deleted successfully | - |
281+
**400** | Invalid request - must specify purgeAll, documentIds, or metadata | - |
282+
**403** | Access denied | - |
283+
**404** | Collection not found | - |
284+
**500** | Failed to delete documents | - |
285+
286+
[[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)
287+
189288
# **get_vector_collection**
190289
> GetVectorCollection200Response get_vector_collection(organisation, collection_id)
191290

0 commit comments

Comments
 (0)