Files
sdk/docs/SimilarApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
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]>
2026-07-25 07:10:32 -07:00

1.7 KiB

SimilarApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
searchFindSimilar POST /v1/search/indexes/{indexUid}/similar Find similar documents

searchFindSimilar

SearchSimilarResult searchFindSimilar(indexUid, searchSimilarQuery)

Find similar documents

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = SimilarApi()
val indexUid : kotlin.String = indexUid_example // kotlin.String | Unique index identifier
val searchSimilarQuery : SearchSimilarQuery =  // SearchSimilarQuery | 
try {
    val result : SearchSimilarResult = apiInstance.searchFindSimilar(indexUid, searchSimilarQuery)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling SimilarApi#searchFindSimilar")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling SimilarApi#searchFindSimilar")
    e.printStackTrace()
}

Parameters

| indexUid | kotlin.String| Unique index identifier | |

Name Type Description Notes
searchSimilarQuery SearchSimilarQuery

Return type

SearchSimilarResult

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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