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]>
11 KiB
OpenAICompatibleApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| aiCreateChatCompletion | POST /v1/chat/completions | Create chat completion |
| aiCreateCompletion | POST /v1/completions | Create completion (legacy text) |
| aiCreateEmbeddings | POST /v1/embeddings | Create embeddings |
| aiCreateImage | POST /v1/images/generations | Create image |
| aiCreateSpeech | POST /v1/audio/speech | Create speech (text-to-speech) |
| aiCreateTranscription | POST /v1/audio/transcriptions | Create transcription (speech-to-text) |
| aiRerank | POST /v1/rerank | Rerank documents against a query |
aiCreateChatCompletion
AiChatCompletionResponse aiCreateChatCompletion(aiChatCompletionRequest)
Create chat completion
OpenAI-compatible chat completions. Set `stream: true` for an SSE token stream (`text/event-stream`), otherwise a single JSON response. `model` accepts any model id from `GET /v1/models` (including the Zen ladder).
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = OpenAICompatibleApi()
val aiChatCompletionRequest : AiChatCompletionRequest = // AiChatCompletionRequest |
try {
val result : AiChatCompletionResponse = apiInstance.aiCreateChatCompletion(aiChatCompletionRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling OpenAICompatibleApi#aiCreateChatCompletion")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling OpenAICompatibleApi#aiCreateChatCompletion")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| aiChatCompletionRequest | AiChatCompletionRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
aiCreateCompletion
kotlin.Any aiCreateCompletion(aiCompletionRequest)
Create completion (legacy text)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = OpenAICompatibleApi()
val aiCompletionRequest : AiCompletionRequest = // AiCompletionRequest |
try {
val result : kotlin.Any = apiInstance.aiCreateCompletion(aiCompletionRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling OpenAICompatibleApi#aiCreateCompletion")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling OpenAICompatibleApi#aiCreateCompletion")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| aiCompletionRequest | AiCompletionRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
aiCreateEmbeddings
AiEmbeddingResponse aiCreateEmbeddings(aiEmbeddingRequest)
Create embeddings
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = OpenAICompatibleApi()
val aiEmbeddingRequest : AiEmbeddingRequest = // AiEmbeddingRequest |
try {
val result : AiEmbeddingResponse = apiInstance.aiCreateEmbeddings(aiEmbeddingRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling OpenAICompatibleApi#aiCreateEmbeddings")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling OpenAICompatibleApi#aiCreateEmbeddings")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| aiEmbeddingRequest | AiEmbeddingRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
aiCreateImage
AiImageResponse aiCreateImage(aiImageGenerationRequest)
Create image
OpenAI-compatible text-to-image generation.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = OpenAICompatibleApi()
val aiImageGenerationRequest : AiImageGenerationRequest = // AiImageGenerationRequest |
try {
val result : AiImageResponse = apiInstance.aiCreateImage(aiImageGenerationRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling OpenAICompatibleApi#aiCreateImage")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling OpenAICompatibleApi#aiCreateImage")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| aiImageGenerationRequest | AiImageGenerationRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
aiCreateSpeech
java.io.File aiCreateSpeech(aiSpeechRequest)
Create speech (text-to-speech)
OpenAI-compatible text-to-speech. Returns binary audio.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = OpenAICompatibleApi()
val aiSpeechRequest : AiSpeechRequest = // AiSpeechRequest |
try {
val result : java.io.File = apiInstance.aiCreateSpeech(aiSpeechRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling OpenAICompatibleApi#aiCreateSpeech")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling OpenAICompatibleApi#aiCreateSpeech")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| aiSpeechRequest | AiSpeechRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/octet-stream, application/json
aiCreateTranscription
AiTranscriptionResponse aiCreateTranscription(file, model, language, prompt, responseFormat, temperature)
Create transcription (speech-to-text)
OpenAI-compatible speech-to-text (Whisper interface).
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = OpenAICompatibleApi()
val file : java.io.File = BINARY_DATA_HERE // java.io.File |
val model : kotlin.String = model_example // kotlin.String |
val language : kotlin.String = language_example // kotlin.String |
val prompt : kotlin.String = prompt_example // kotlin.String |
val responseFormat : kotlin.String = responseFormat_example // kotlin.String |
val temperature : java.math.BigDecimal = 8.14 // java.math.BigDecimal |
try {
val result : AiTranscriptionResponse = apiInstance.aiCreateTranscription(file, model, language, prompt, responseFormat, temperature)
println(result)
} catch (e: ClientException) {
println("4xx response calling OpenAICompatibleApi#aiCreateTranscription")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling OpenAICompatibleApi#aiCreateTranscription")
e.printStackTrace()
}
Parameters
| file | java.io.File| | | | model | kotlin.String| | | | language | kotlin.String| | [optional] | | prompt | kotlin.String| | [optional] | | responseFormat | kotlin.String| | [optional] [enum: json, text, srt, verbose_json, vtt] |
| Name | Type | Description | Notes |
|---|---|---|---|
| temperature | java.math.BigDecimal | [optional] |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: multipart/form-data
- Accept: application/json
aiRerank
kotlin.Any aiRerank(aiRerankRequest)
Rerank documents against a query
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = OpenAICompatibleApi()
val aiRerankRequest : AiRerankRequest = // AiRerankRequest |
try {
val result : kotlin.Any = apiInstance.aiRerank(aiRerankRequest)
println(result)
} catch (e: ClientException) {
println("4xx response calling OpenAICompatibleApi#aiRerank")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling OpenAICompatibleApi#aiRerank")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| aiRerankRequest | AiRerankRequest |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json