com.volcengine.ark.runtime.service

Interface ArkApi

public interface ArkApi

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<BotChatCompletionResult>	createBotChatCompletion(BotChatCompletionRequest request, String botId, Map<String,String> customHeaders)
retrofit2.Call<okhttp3.ResponseBody>	createBotChatCompletionStream(BotChatCompletionRequest request, String botId, Map<String,String> customHeaders)
io.reactivex.Single<ChatCompletionResult>	createChatCompletion(ChatCompletionRequest request, String model, Map<String,String> customHeaders)
retrofit2.Call<okhttp3.ResponseBody>	createChatCompletionStream(ChatCompletionRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<EmbeddingResult>	createEmbeddings(EmbeddingRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<TokenizationResult>	createTokenization(TokenizationRequest request, String model, Map<String,String> customHeaders)

Method Detail

createChatCompletion

@POST(value="/api/v3/chat/completions")
io.reactivex.Single<ChatCompletionResult> createChatCompletion(@Body
                                                                                                       ChatCompletionRequest request,
                                                                                                       @Header(value="X-Request-Model")
                                                                                                       String model,
                                                                                                       @HeaderMap
                                                                                                       Map<String,String> customHeaders)

createChatCompletionStream

@Streaming
 @POST(value="/api/v3/chat/completions")
retrofit2.Call<okhttp3.ResponseBody> createChatCompletionStream(@Body
                                                                                                                    ChatCompletionRequest request,
                                                                                                                    @Header(value="X-Request-Model")
                                                                                                                    String model,
                                                                                                                    @HeaderMap
                                                                                                                    Map<String,String> customHeaders)

createBotChatCompletion

@POST(value="/api/v3/bots/chat/completions")
io.reactivex.Single<BotChatCompletionResult> createBotChatCompletion(@Body
                                                                                                                  BotChatCompletionRequest request,
                                                                                                                  @Header(value="X-Request-Bot")
                                                                                                                  String botId,
                                                                                                                  @HeaderMap
                                                                                                                  Map<String,String> customHeaders)

createBotChatCompletionStream

@Streaming
 @POST(value="/api/v3/bots/chat/completions")
retrofit2.Call<okhttp3.ResponseBody> createBotChatCompletionStream(@Body
                                                                                                                            BotChatCompletionRequest request,
                                                                                                                            @Header(value="X-Request-Bot")
                                                                                                                            String botId,
                                                                                                                            @HeaderMap
                                                                                                                            Map<String,String> customHeaders)

createEmbeddings

@POST(value="/api/v3/embeddings")
io.reactivex.Single<EmbeddingResult> createEmbeddings(@Body
                                                                                        EmbeddingRequest request,
                                                                                        @Header(value="X-Request-Model")
                                                                                        String model,
                                                                                        @HeaderMap
                                                                                        Map<String,String> customHeaders)

createTokenization

@POST(value="/api/v3/tokenization")
io.reactivex.Single<TokenizationResult> createTokenization(@Body
                                                                                               TokenizationRequest request,
                                                                                               @Header(value="X-Request-Model")
                                                                                               String model,
                                                                                               @HeaderMap
                                                                                               Map<String,String> customHeaders)