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]>
5.1 KiB
PointsApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| vectorDeletePoints | POST /v1/vector/collections/{collection_name}/points/delete | Delete points |
| vectorGetPoint | GET /v1/vector/collections/{collection_name}/points/{id} | Get point |
| vectorUpsertPoints | PUT /v1/vector/collections/{collection_name}/points | Upsert points |
vectorDeletePoints
VectorDeletePoints200Response vectorDeletePoints(collectionName, vectorDeletePointsRequest, wait)
Delete points
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = PointsApi()
val collectionName : kotlin.String = collectionName_example // kotlin.String |
val vectorDeletePointsRequest : VectorDeletePointsRequest = // VectorDeletePointsRequest |
val wait : kotlin.Boolean = true // kotlin.Boolean |
try {
val result : VectorDeletePoints200Response = apiInstance.vectorDeletePoints(collectionName, vectorDeletePointsRequest, wait)
println(result)
} catch (e: ClientException) {
println("4xx response calling PointsApi#vectorDeletePoints")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling PointsApi#vectorDeletePoints")
e.printStackTrace()
}
Parameters
| collectionName | kotlin.String| | | | vectorDeletePointsRequest | VectorDeletePointsRequest| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| wait | kotlin.Boolean | [optional] [default to true] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
vectorGetPoint
VectorGetPoint200Response vectorGetPoint(collectionName, id)
Get point
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = PointsApi()
val collectionName : kotlin.String = collectionName_example // kotlin.String |
val id : VectorDeletePointsRequestPointsInner = // VectorDeletePointsRequestPointsInner |
try {
val result : VectorGetPoint200Response = apiInstance.vectorGetPoint(collectionName, id)
println(result)
} catch (e: ClientException) {
println("4xx response calling PointsApi#vectorGetPoint")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling PointsApi#vectorGetPoint")
e.printStackTrace()
}
Parameters
| collectionName | kotlin.String| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| id | VectorDeletePointsRequestPointsInner |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
vectorUpsertPoints
VectorUpsertPoints200Response vectorUpsertPoints(collectionName, vectorUpsertPointsRequest, wait)
Upsert points
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = PointsApi()
val collectionName : kotlin.String = collectionName_example // kotlin.String |
val vectorUpsertPointsRequest : VectorUpsertPointsRequest = // VectorUpsertPointsRequest |
val wait : kotlin.Boolean = true // kotlin.Boolean |
try {
val result : VectorUpsertPoints200Response = apiInstance.vectorUpsertPoints(collectionName, vectorUpsertPointsRequest, wait)
println(result)
} catch (e: ClientException) {
println("4xx response calling PointsApi#vectorUpsertPoints")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling PointsApi#vectorUpsertPoints")
e.printStackTrace()
}
Parameters
| collectionName | kotlin.String| | | | vectorUpsertPointsRequest | VectorUpsertPointsRequest| | |
| Name | Type | Description | Notes |
|---|---|---|---|
| wait | kotlin.Boolean | [optional] [default to true] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json