Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and Android. Generated with openapi-generator kotlin (library=jvm-okhttp4, useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai. Co-authored-by: Hanzo Dev <[email protected]>
7.2 KiB
SnapshotsApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| searchCreateSnapshot | POST /v1/search/snapshots | Create a database snapshot |
| vectorCreateSnapshot | POST /v1/vector/collections/{collection_name}/snapshots | Create snapshot |
| vectorDeleteSnapshot | DELETE /v1/vector/collections/{collection_name}/snapshots/{snapshot_name} | Delete snapshot |
| vectorDownloadSnapshot | GET /v1/vector/collections/{collection_name}/snapshots/{snapshot_name} | Download snapshot |
| vectorListSnapshots | GET /v1/vector/collections/{collection_name}/snapshots | List snapshots |
searchCreateSnapshot
SearchSummarizedTaskView searchCreateSnapshot()
Create a database snapshot
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SnapshotsApi()
try {
val result : SearchSummarizedTaskView = apiInstance.searchCreateSnapshot()
println(result)
} catch (e: ClientException) {
println("4xx response calling SnapshotsApi#searchCreateSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SnapshotsApi#searchCreateSnapshot")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
vectorCreateSnapshot
VectorCreateSnapshot200Response vectorCreateSnapshot(collectionName)
Create snapshot
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SnapshotsApi()
val collectionName : kotlin.String = collectionName_example // kotlin.String |
try {
val result : VectorCreateSnapshot200Response = apiInstance.vectorCreateSnapshot(collectionName)
println(result)
} catch (e: ClientException) {
println("4xx response calling SnapshotsApi#vectorCreateSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SnapshotsApi#vectorCreateSnapshot")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | kotlin.String |
Return type
VectorCreateSnapshot200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
vectorDeleteSnapshot
VectorCreateCollection200Response vectorDeleteSnapshot(collectionName, snapshotName)
Delete snapshot
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SnapshotsApi()
val collectionName : kotlin.String = collectionName_example // kotlin.String |
val snapshotName : kotlin.String = snapshotName_example // kotlin.String |
try {
val result : VectorCreateCollection200Response = apiInstance.vectorDeleteSnapshot(collectionName, snapshotName)
println(result)
} catch (e: ClientException) {
println("4xx response calling SnapshotsApi#vectorDeleteSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SnapshotsApi#vectorDeleteSnapshot")
e.printStackTrace()
}
Parameters
| collectionName | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| snapshotName | kotlin.String |
Return type
VectorCreateCollection200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
vectorDownloadSnapshot
java.io.File vectorDownloadSnapshot(collectionName, snapshotName)
Download snapshot
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SnapshotsApi()
val collectionName : kotlin.String = collectionName_example // kotlin.String |
val snapshotName : kotlin.String = snapshotName_example // kotlin.String |
try {
val result : java.io.File = apiInstance.vectorDownloadSnapshot(collectionName, snapshotName)
println(result)
} catch (e: ClientException) {
println("4xx response calling SnapshotsApi#vectorDownloadSnapshot")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SnapshotsApi#vectorDownloadSnapshot")
e.printStackTrace()
}
Parameters
| collectionName | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| snapshotName | kotlin.String |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/octet-stream
vectorListSnapshots
VectorListSnapshots200Response vectorListSnapshots(collectionName)
List snapshots
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SnapshotsApi()
val collectionName : kotlin.String = collectionName_example // kotlin.String |
try {
val result : VectorListSnapshots200Response = apiInstance.vectorListSnapshots(collectionName)
println(result)
} catch (e: ClientException) {
println("4xx response calling SnapshotsApi#vectorListSnapshots")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SnapshotsApi#vectorListSnapshots")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| collectionName | kotlin.String |
Return type
VectorListSnapshots200Response
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json