Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
138 changes: 132 additions & 6 deletions .openapi-generator/FILES

Large diffs are not rendered by default.

75 changes: 71 additions & 4 deletions README.md

Large diffs are not rendered by default.

796 changes: 796 additions & 0 deletions docs/AIOrchestrationsApi.md

Large diffs are not rendered by default.

980 changes: 980 additions & 0 deletions docs/AISkillsApi.md

Large diffs are not rendered by default.

11 changes: 7 additions & 4 deletions docs/AIToolsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ All URIs are relative to *https://dashboard.quantcdn.io*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_ai_orchestration_status**](AIToolsApi.md#get_ai_orchestration_status) | **GET** /api/v3/organizations/{organisation}/ai/tools/orchestrations/{orchestrationId} | Get Orchestration Status
[**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)
[**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
[**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
[**list_ai_tool_names**](AIToolsApi.md#list_ai_tool_names) | **GET** /api/v3/organizations/{organisation}/ai/tools/names | List tool names only (lightweight response)
Expand All @@ -14,9 +14,12 @@ Method | HTTP request | Description
# **get_ai_orchestration_status**
> GetAIOrchestrationStatus200Response get_ai_orchestration_status(organisation, orchestration_id)

Get Orchestration Status
Get Tool Orchestration Status (Async Tool Polling)

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

try:
# Get Orchestration Status
# Get Tool Orchestration Status (Async Tool Polling)
api_response = api_instance.get_ai_orchestration_status(organisation, orchestration_id)
print("The response of AIToolsApi->get_ai_orchestration_status:\n")
pprint(api_response)
Expand Down
105 changes: 102 additions & 3 deletions docs/AIVectorDatabaseApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**create_vector_collection**](AIVectorDatabaseApi.md#create_vector_collection) | **POST** /api/v3/organizations/{organisation}/ai/vector-db/collections | Create Vector Database Collection
[**delete_vector_collection**](AIVectorDatabaseApi.md#delete_vector_collection) | **DELETE** /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId} | Delete Collection
[**delete_vector_documents**](AIVectorDatabaseApi.md#delete_vector_documents) | **DELETE** /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId}/documents | Delete Documents from Collection
[**get_vector_collection**](AIVectorDatabaseApi.md#get_vector_collection) | **GET** /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId} | Get Collection Details
[**list_vector_collections**](AIVectorDatabaseApi.md#list_vector_collections) | **GET** /api/v3/organizations/{organisation}/ai/vector-db/collections | List Vector Database Collections
[**query_vector_collection**](AIVectorDatabaseApi.md#query_vector_collection) | **POST** /api/v3/organizations/{organisation}/ai/vector-db/collections/{collectionId}/query | Semantic Search Query
Expand Down Expand Up @@ -104,7 +105,7 @@ Name | Type | Description | Notes
[[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)

# **delete_vector_collection**
> DeleteVectorCollection200Response delete_vector_collection(organisation, collection_id)
> DeleteSkillCollection200Response delete_vector_collection(organisation, collection_id)

Delete Collection

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

```python
import quantcdn
from quantcdn.models.delete_vector_collection200_response import DeleteVectorCollection200Response
from quantcdn.models.delete_skill_collection200_response import DeleteSkillCollection200Response
from quantcdn.rest import ApiException
from pprint import pprint

Expand Down Expand Up @@ -164,7 +165,7 @@ Name | Type | Description | Notes

### Return type

[**DeleteVectorCollection200Response**](DeleteVectorCollection200Response.md)
[**DeleteSkillCollection200Response**](DeleteSkillCollection200Response.md)

### Authorization

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

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

# **delete_vector_documents**
> DeleteVectorDocuments200Response delete_vector_documents(organisation, collection_id, delete_vector_documents_request)

Delete Documents from Collection

Delete documents from a collection. Supports three deletion modes:
*
* 1. **Purge All** - Set `purgeAll: true` to delete ALL documents in the collection
*
* 2. **By Document IDs** - Provide `documentIds` array with specific document UUIDs
*
* 3. **By Metadata** - Provide `metadata` object with `field` and `values` to delete documents where the metadata field matches any of the values
*
* **Drupal Integration:**
* When using with Drupal AI Search, use metadata deletion with:
* - `field: 'drupal_entity_id'` to delete all chunks for specific entities
* - `field: 'drupal_long_id'` to delete specific chunks

### Example

* Bearer (JWT) Authentication (BearerAuth):

```python
import quantcdn
from quantcdn.models.delete_vector_documents200_response import DeleteVectorDocuments200Response
from quantcdn.models.delete_vector_documents_request import DeleteVectorDocumentsRequest
from quantcdn.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://dashboard.quantcdn.io
# See configuration.py for a list of all supported configuration parameters.
configuration = quantcdn.Configuration(
host = "https://dashboard.quantcdn.io"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): BearerAuth
configuration = quantcdn.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with quantcdn.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = quantcdn.AIVectorDatabaseApi(api_client)
organisation = 'organisation_example' # str | Organisation machine name
collection_id = 'collection_id_example' # str | Collection UUID
delete_vector_documents_request = quantcdn.DeleteVectorDocumentsRequest() # DeleteVectorDocumentsRequest |

try:
# Delete Documents from Collection
api_response = api_instance.delete_vector_documents(organisation, collection_id, delete_vector_documents_request)
print("The response of AIVectorDatabaseApi->delete_vector_documents:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling AIVectorDatabaseApi->delete_vector_documents: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**organisation** | **str**| Organisation machine name |
**collection_id** | **str**| Collection UUID |
**delete_vector_documents_request** | [**DeleteVectorDocumentsRequest**](DeleteVectorDocumentsRequest.md)| |

### Return type

[**DeleteVectorDocuments200Response**](DeleteVectorDocuments200Response.md)

### Authorization

[BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Documents deleted successfully | - |
**400** | Invalid request - must specify purgeAll, documentIds, or metadata | - |
**403** | Access denied | - |
**404** | Collection not found | - |
**500** | Failed to delete documents | - |

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

# **get_vector_collection**
> GetVectorCollection200Response get_vector_collection(organisation, collection_id)

Expand Down
Loading