com.volcengine.ark.runtime.service

Interface ArkApi

public interface ArkApi

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<ChatCompletionResult>	createBatchChatCompletion(ChatCompletionRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<EmbeddingResult>	createBatchEmbeddings(EmbeddingRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<MultimodalEmbeddingResult>	createBatchMultiModalEmbeddings(MultimodalEmbeddingRequest request, String model, Map<String,String> customHeaders)
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<CreateContentGenerationTaskResult>	createContentGenerationTask(CreateContentGenerationTaskRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<CreateContextResult>	createContext(CreateContextRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<ChatCompletionResult>	createContextChatCompletion(ContextChatCompletionRequest request, String model, Map<String,String> customHeaders)
retrofit2.Call<okhttp3.ResponseBody>	createContextChatCompletionStream(ContextChatCompletionRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<EmbeddingResult>	createEmbeddings(EmbeddingRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<MultimodalEmbeddingResult>	createMultiModalEmbeddings(MultimodalEmbeddingRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<ResponseObject>	createResponse(CreateResponsesRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<TokenizationResult>	createTokenization(TokenizationRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<DeleteContentGenerationTaskResponse>	deleteContentGenerationTask(String taskId, Map<String,String> customHeaders)
io.reactivex.Single<DeleteResponseResponse>	deleteResponse(String responsesId, Map<String,String> customHeaders)
io.reactivex.Single<ImagesResponse>	generateImages(GenerateImagesRequest request, String model, Map<String,String> customHeaders)
io.reactivex.Single<GetContentGenerationTaskResponse>	getContentGenerationTask(String taskId, Map<String,String> customHeaders)
io.reactivex.Single<ResponseObject>	getResponse(String responsesId, Map<String,String> customHeaders)
io.reactivex.Single<ListContentGenerationTasksResponse>	listContentGenerationTasks(int pageNum, int pageSize, String status, String model, List<String> taskIds, Map<String,String> customHeaders)
io.reactivex.Single<ListInputItemsResponse>	listResponseInputItems(String responsesId, String after, String before, Integer limit, List<String> include, Map<String,String> customHeaders)
retrofit2.Call<okhttp3.ResponseBody>	streamGenerateImages(GenerateImagesRequest request, String model, Map<String,String> customHeaders)
retrofit2.Call<okhttp3.ResponseBody>	streamResponse(CreateResponsesRequest 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)

createBatchChatCompletion

@POST(value="/api/v3/batch/chat/completions")
io.reactivex.Single<ChatCompletionResult> createBatchChatCompletion(@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)

createContext

@POST(value="/api/v3/context/create")
io.reactivex.Single<CreateContextResult> createContext(@Body
                                                                                             CreateContextRequest request,
                                                                                             @Header(value="X-Request-Model")
                                                                                             String model,
                                                                                             @HeaderMap
                                                                                             Map<String,String> customHeaders)

createContextChatCompletion

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

createContextChatCompletionStream

@Streaming
 @POST(value="/api/v3/context/chat/completions")
retrofit2.Call<okhttp3.ResponseBody> createContextChatCompletionStream(@Body
                                                                                                                                   ContextChatCompletionRequest request,
                                                                                                                                   @Header(value="X-Request-Model")
                                                                                                                                   String model,
                                                                                                                                   @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)

createBatchEmbeddings

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

createMultiModalEmbeddings

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

createBatchMultiModalEmbeddings

@POST(value="/api/v3/batch/embeddings/multimodal")
io.reactivex.Single<MultimodalEmbeddingResult> createBatchMultiModalEmbeddings(@Body
                                                                                                                                  MultimodalEmbeddingRequest 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)

generateImages

@POST(value="/api/v3/images/generations")
io.reactivex.Single<ImagesResponse> generateImages(@Body
                                                                                             GenerateImagesRequest request,
                                                                                             @Header(value="X-Request-Model")
                                                                                             String model,
                                                                                             @HeaderMap
                                                                                             Map<String,String> customHeaders)

streamGenerateImages

@Streaming
 @POST(value="/api/v3/images/generations")
retrofit2.Call<okhttp3.ResponseBody> streamGenerateImages(@Body
                                                                                                                GenerateImagesRequest request,
                                                                                                                @Header(value="X-Request-Model")
                                                                                                                String model,
                                                                                                                @HeaderMap
                                                                                                                Map<String,String> customHeaders)

createContentGenerationTask

@POST(value="/api/v3/contents/generations/tasks")
io.reactivex.Single<CreateContentGenerationTaskResult> createContentGenerationTask(@Body
                                                                                                                                     CreateContentGenerationTaskRequest request,
                                                                                                                                     @Header(value="X-Request-Model")
                                                                                                                                     String model,
                                                                                                                                     @HeaderMap
                                                                                                                                     Map<String,String> customHeaders)

getContentGenerationTask

@GET(value="/api/v3/contents/generations/tasks/{taskId}")
io.reactivex.Single<GetContentGenerationTaskResponse> getContentGenerationTask(@Path(value="taskId")
                                                                                                                                         String taskId,
                                                                                                                                         @HeaderMap
                                                                                                                                         Map<String,String> customHeaders)

listContentGenerationTasks

@GET(value="/api/v3/contents/generations/tasks")
io.reactivex.Single<ListContentGenerationTasksResponse> listContentGenerationTasks(@Query(value="page_num")
                                                                                                                                    int pageNum,
                                                                                                                                    @Query(value="page_size")
                                                                                                                                    int pageSize,
                                                                                                                                    @Query(value="filter.status")
                                                                                                                                    String status,
                                                                                                                                    @Query(value="filter.model")
                                                                                                                                    String model,
                                                                                                                                    @Query(value="filter.task_ids")
                                                                                                                                    List<String> taskIds,
                                                                                                                                    @HeaderMap
                                                                                                                                    Map<String,String> customHeaders)

deleteContentGenerationTask

@DELETE(value="/api/v3/contents/generations/tasks/{taskId}")
io.reactivex.Single<DeleteContentGenerationTaskResponse> deleteContentGenerationTask(@Path(value="taskId")
                                                                                                                                                  String taskId,
                                                                                                                                                  @HeaderMap
                                                                                                                                                  Map<String,String> customHeaders)

createResponse

@POST(value="/api/v3/responses")
io.reactivex.Single<ResponseObject> createResponse(@Body
                                                                                    CreateResponsesRequest request,
                                                                                    @Header(value="X-Request-Model")
                                                                                    String model,
                                                                                    @HeaderMap
                                                                                    Map<String,String> customHeaders)

streamResponse

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

getResponse

@GET(value="/api/v3/responses/{responseId}")
io.reactivex.Single<ResponseObject> getResponse(@Path(value="responseId")
                                                                                             String responsesId,
                                                                                             @HeaderMap
                                                                                             Map<String,String> customHeaders)

deleteResponse

@DELETE(value="/api/v3/responses/{responseId}")
io.reactivex.Single<DeleteResponseResponse> deleteResponse(@Path(value="responseId")
                                                                                                           String responsesId,
                                                                                                           @HeaderMap
                                                                                                           Map<String,String> customHeaders)

listResponseInputItems

@GET(value="/api/v3/responses/{responseId}/input_items")
io.reactivex.Single<ListInputItemsResponse> listResponseInputItems(@Path(value="responseId")
                                                                                                                            String responsesId,
                                                                                                                            @Query(value="after")
                                                                                                                            String after,
                                                                                                                            @Query(value="before")
                                                                                                                            String before,
                                                                                                                            @Query(value="limit")
                                                                                                                            Integer limit,
                                                                                                                            @Query(value="include[]")
                                                                                                                            List<String> include,
                                                                                                                            @HeaderMap
                                                                                                                            Map<String,String> customHeaders)