com.byteplus.ark.runtime.service

Class ArkService

java.lang.Object

com.byteplus.ark.runtime.service.ArkBaseService

com.byteplus.ark.runtime.service.ArkService

All Implemented Interfaces:

ArkBaseServiceImpl

public class ArkService
extends ArkBaseService
implements ArkBaseServiceImpl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArkService.Builder

Field Summary

Fields inherited from class com.byteplus.ark.runtime.service.ArkBaseService

BASE_REGION, BASE_URL, DEFAULT_CONNECT_TIMEOUT, DEFAULT_RETRY_TIMES, DEFAULT_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ArkService(ArkApi api)
ArkService(ArkApi api, ExecutorService executorService)
ArkService(String apiKey)
ArkService(String apiKey, Duration timeout)
ArkService(String ak, String sk)
ArkService(String ak, String sk, Duration timeout)

Method Summary

Modifier and Type	Method and Description
static ArkService.Builder	builder()
ChatCompletionResult	createBatchChatCompletion(ChatCompletionRequest request)
ChatCompletionResult	createBatchChatCompletion(ChatCompletionRequest request, Map<String,String> customHeaders)
EmbeddingResult	createBatchEmbeddings(EmbeddingRequest request)
EmbeddingResult	createBatchEmbeddings(EmbeddingRequest request, Map<String,String> customHeaders)
MultimodalEmbeddingResult	createBatchMultiModalEmbeddings(MultimodalEmbeddingRequest request)
MultimodalEmbeddingResult	createBatchMultiModalEmbeddings(MultimodalEmbeddingRequest request, Map<String,String> customHeaders)
ChatCompletionResult	createChatCompletion(ChatCompletionRequest request)
ChatCompletionResult	createChatCompletion(ChatCompletionRequest request, Map<String,String> customHeaders)
CreateContentGenerationTaskResult	createContentGenerationTask(CreateContentGenerationTaskRequest request)
CreateContentGenerationTaskResult	createContentGenerationTask(CreateContentGenerationTaskRequest request, Map<String,String> customHeaders)
CreateContextResult	createContext(CreateContextRequest request)
CreateContextResult	createContext(CreateContextRequest request, Map<String,String> customHeaders)
ChatCompletionResult	createContextChatCompletion(ContextChatCompletionRequest request)
ChatCompletionResult	createContextChatCompletion(ContextChatCompletionRequest request, Map<String,String> customHeaders)
EmbeddingResult	createEmbeddings(EmbeddingRequest request)
EmbeddingResult	createEmbeddings(EmbeddingRequest request, Map<String,String> customHeaders)
MultimodalEmbeddingResult	createMultiModalEmbeddings(MultimodalEmbeddingRequest request)
MultimodalEmbeddingResult	createMultiModalEmbeddings(MultimodalEmbeddingRequest request, Map<String,String> customHeaders)
ResponseObject	createResponse(CreateResponsesRequest request)
ResponseObject	createResponse(CreateResponsesRequest request, Map<String,String> customHeaders)
static okhttp3.OkHttpClient	defaultApiKeyClient(String apiKey, Duration timeout)
static com.fasterxml.jackson.databind.ObjectMapper	defaultObjectMapper()
static okhttp3.OkHttpClient	defaultResourceStsClient(String ak, String sk, Duration timeout, String region)
static retrofit2.Retrofit	defaultRetrofit(okhttp3.OkHttpClient client, com.fasterxml.jackson.databind.ObjectMapper mapper, String baseUrl, Executor callbackExecutor)
DeleteContentGenerationTaskResponse	deleteContentGenerationTask(DeleteContentGenerationTaskRequest request)
DeleteContentGenerationTaskResponse	deleteContentGenerationTask(DeleteContentGenerationTaskRequest request, Map<String,String> customHeaders)
DeleteFileResponse	deleteFile(String fileId)
DeleteResponseResponse	deleteResponse(DeleteResponseRequest request)
static <T> T	execute(io.reactivex.Single<T> apiCall)
ImagesResponse	generateImages(GenerateImagesRequest request)
ImagesResponse	generateImages(GenerateImagesRequest request, Map<String,String> customHeaders)
GetContentGenerationTaskResponse	getContentGenerationTask(GetContentGenerationTaskRequest request)
GetContentGenerationTaskResponse	getContentGenerationTask(GetContentGenerationTaskRequest request, Map<String,String> customHeaders)
ResponseObject	getResponse(GetResponseRequest request)
ListContentGenerationTasksResponse	listContentGenerationTasks(ListContentGenerationTasksRequest request)
ListContentGenerationTasksResponse	listContentGenerationTasks(ListContentGenerationTasksRequest request, Map<String,String> customHeaders)
ListFilesResponse	listFiles(ListFilesRequest request)
ListInputItemsResponse	listResponseInputItems(ListInputItemsRequest request)
FileMeta	retrieveFile(String fileId)
void	shutdownExecutor()
static io.reactivex.Flowable<SSE>	stream(retrofit2.Call<okhttp3.ResponseBody> apiCall)
static io.reactivex.Flowable<SSE>	stream(retrofit2.Call<okhttp3.ResponseBody> apiCall, boolean emitDone)
static <T> io.reactivex.Flowable<T>	stream(retrofit2.Call<okhttp3.ResponseBody> apiCall, Class<T> cl)
io.reactivex.Flowable<ChatCompletionChunk>	streamChatCompletion(ChatCompletionRequest request)
io.reactivex.Flowable<ChatCompletionChunk>	streamChatCompletion(ChatCompletionRequest request, Map<String,String> customHeaders)
io.reactivex.Flowable<ChatCompletionChunk>	streamContextChatCompletion(ContextChatCompletionRequest request)
io.reactivex.Flowable<ChatCompletionChunk>	streamContextChatCompletion(ContextChatCompletionRequest request, Map<String,String> customHeaders)
io.reactivex.Flowable<ImageGenStreamEvent>	streamGenerateImages(GenerateImagesRequest request)
io.reactivex.Flowable<ImageGenStreamEvent>	streamGenerateImages(GenerateImagesRequest request, Map<String,String> customHeaders)
io.reactivex.Flowable<StreamEvent>	streamResponse(CreateResponsesRequest request)
io.reactivex.Flowable<StreamEvent>	streamResponse(CreateResponsesRequest request, Map<String,String> customHeaders)
FileMeta	uploadFile(UploadFileRequest request)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArkService

public ArkService(String apiKey)

ArkService

public ArkService(String apiKey,
                  Duration timeout)

ArkService

public ArkService(String ak,
                  String sk)

ArkService

public ArkService(String ak,
                  String sk,
                  Duration timeout)

ArkService

public ArkService(ArkApi api)

ArkService

public ArkService(ArkApi api,
                  ExecutorService executorService)

Method Detail

defaultObjectMapper

public static com.fasterxml.jackson.databind.ObjectMapper defaultObjectMapper()

defaultApiKeyClient

public static okhttp3.OkHttpClient defaultApiKeyClient(String apiKey,
                                                       Duration timeout)

defaultResourceStsClient

public static okhttp3.OkHttpClient defaultResourceStsClient(String ak,
                                                            String sk,
                                                            Duration timeout,
                                                            String region)

defaultRetrofit

public static retrofit2.Retrofit defaultRetrofit(okhttp3.OkHttpClient client,
                                                 com.fasterxml.jackson.databind.ObjectMapper mapper,
                                                 String baseUrl,
                                                 Executor callbackExecutor)

execute

public static <T> T execute(io.reactivex.Single<T> apiCall)

stream

public static io.reactivex.Flowable<SSE> stream(retrofit2.Call<okhttp3.ResponseBody> apiCall)

stream

public static io.reactivex.Flowable<SSE> stream(retrofit2.Call<okhttp3.ResponseBody> apiCall,
                                                boolean emitDone)

stream

public static <T> io.reactivex.Flowable<T> stream(retrofit2.Call<okhttp3.ResponseBody> apiCall,
                                                  Class<T> cl)

createChatCompletion

public ChatCompletionResult createChatCompletion(ChatCompletionRequest request)

Specified by:

createChatCompletion in interface ArkBaseServiceImpl

createBatchChatCompletion

public ChatCompletionResult createBatchChatCompletion(ChatCompletionRequest request)

Specified by:

createBatchChatCompletion in interface ArkBaseServiceImpl

createChatCompletion

public ChatCompletionResult createChatCompletion(ChatCompletionRequest request,
                                                 Map<String,String> customHeaders)

createBatchChatCompletion

public ChatCompletionResult createBatchChatCompletion(ChatCompletionRequest request,
                                                      Map<String,String> customHeaders)

streamChatCompletion

public io.reactivex.Flowable<ChatCompletionChunk> streamChatCompletion(ChatCompletionRequest request)

Specified by:

streamChatCompletion in interface ArkBaseServiceImpl

streamChatCompletion

public io.reactivex.Flowable<ChatCompletionChunk> streamChatCompletion(ChatCompletionRequest request,
                                                                       Map<String,String> customHeaders)

createEmbeddings

public EmbeddingResult createEmbeddings(EmbeddingRequest request)

Specified by:

createEmbeddings in interface ArkBaseServiceImpl

createEmbeddings

public EmbeddingResult createEmbeddings(EmbeddingRequest request,
                                        Map<String,String> customHeaders)

createBatchEmbeddings

public EmbeddingResult createBatchEmbeddings(EmbeddingRequest request)

Specified by:

createBatchEmbeddings in interface ArkBaseServiceImpl

createBatchEmbeddings

public EmbeddingResult createBatchEmbeddings(EmbeddingRequest request,
                                             Map<String,String> customHeaders)

createMultiModalEmbeddings

public MultimodalEmbeddingResult createMultiModalEmbeddings(MultimodalEmbeddingRequest request)

Specified by:

createMultiModalEmbeddings in interface ArkBaseServiceImpl

createMultiModalEmbeddings

public MultimodalEmbeddingResult createMultiModalEmbeddings(MultimodalEmbeddingRequest request,
                                                            Map<String,String> customHeaders)

createBatchMultiModalEmbeddings

public MultimodalEmbeddingResult createBatchMultiModalEmbeddings(MultimodalEmbeddingRequest request)

Specified by:

createBatchMultiModalEmbeddings in interface ArkBaseServiceImpl

createBatchMultiModalEmbeddings

public MultimodalEmbeddingResult createBatchMultiModalEmbeddings(MultimodalEmbeddingRequest request,
                                                                 Map<String,String> customHeaders)

createContext

public CreateContextResult createContext(CreateContextRequest request)

Specified by:

createContext in interface ArkBaseServiceImpl

createContext

public CreateContextResult createContext(CreateContextRequest request,
                                         Map<String,String> customHeaders)

createContextChatCompletion

public ChatCompletionResult createContextChatCompletion(ContextChatCompletionRequest request)

Specified by:

createContextChatCompletion in interface ArkBaseServiceImpl

createContextChatCompletion

public ChatCompletionResult createContextChatCompletion(ContextChatCompletionRequest request,
                                                        Map<String,String> customHeaders)

streamContextChatCompletion

public io.reactivex.Flowable<ChatCompletionChunk> streamContextChatCompletion(ContextChatCompletionRequest request)

Specified by:

streamContextChatCompletion in interface ArkBaseServiceImpl

streamContextChatCompletion

public io.reactivex.Flowable<ChatCompletionChunk> streamContextChatCompletion(ContextChatCompletionRequest request,
                                                                              Map<String,String> customHeaders)

generateImages

public ImagesResponse generateImages(GenerateImagesRequest request)

Specified by:

generateImages in interface ArkBaseServiceImpl

generateImages

public ImagesResponse generateImages(GenerateImagesRequest request,
                                     Map<String,String> customHeaders)

streamGenerateImages

public io.reactivex.Flowable<ImageGenStreamEvent> streamGenerateImages(GenerateImagesRequest request)

streamGenerateImages

public io.reactivex.Flowable<ImageGenStreamEvent> streamGenerateImages(GenerateImagesRequest request,
                                                                       Map<String,String> customHeaders)

createContentGenerationTask

public CreateContentGenerationTaskResult createContentGenerationTask(CreateContentGenerationTaskRequest request)

Specified by:

createContentGenerationTask in interface ArkBaseServiceImpl

createContentGenerationTask

public CreateContentGenerationTaskResult createContentGenerationTask(CreateContentGenerationTaskRequest request,
                                                                     Map<String,String> customHeaders)

getContentGenerationTask

public GetContentGenerationTaskResponse getContentGenerationTask(GetContentGenerationTaskRequest request)

Specified by:

getContentGenerationTask in interface ArkBaseServiceImpl

getContentGenerationTask

public GetContentGenerationTaskResponse getContentGenerationTask(GetContentGenerationTaskRequest request,
                                                                 Map<String,String> customHeaders)

listContentGenerationTasks

public ListContentGenerationTasksResponse listContentGenerationTasks(ListContentGenerationTasksRequest request)

Specified by:

listContentGenerationTasks in interface ArkBaseServiceImpl

listContentGenerationTasks

public ListContentGenerationTasksResponse listContentGenerationTasks(ListContentGenerationTasksRequest request,
                                                                     Map<String,String> customHeaders)

deleteContentGenerationTask

public DeleteContentGenerationTaskResponse deleteContentGenerationTask(DeleteContentGenerationTaskRequest request)

Specified by:

deleteContentGenerationTask in interface ArkBaseServiceImpl

deleteContentGenerationTask

public DeleteContentGenerationTaskResponse deleteContentGenerationTask(DeleteContentGenerationTaskRequest request,
                                                                       Map<String,String> customHeaders)

createResponse

public ResponseObject createResponse(CreateResponsesRequest request)

Specified by:

createResponse in interface ArkBaseServiceImpl

createResponse

public ResponseObject createResponse(CreateResponsesRequest request,
                                     Map<String,String> customHeaders)

streamResponse

public io.reactivex.Flowable<StreamEvent> streamResponse(CreateResponsesRequest request)

Specified by:

streamResponse in interface ArkBaseServiceImpl

streamResponse

public io.reactivex.Flowable<StreamEvent> streamResponse(CreateResponsesRequest request,
                                                         Map<String,String> customHeaders)

getResponse

public ResponseObject getResponse(GetResponseRequest request)

Specified by:

getResponse in interface ArkBaseServiceImpl

deleteResponse

public DeleteResponseResponse deleteResponse(DeleteResponseRequest request)

Specified by:

deleteResponse in interface ArkBaseServiceImpl

listResponseInputItems

public ListInputItemsResponse listResponseInputItems(ListInputItemsRequest request)

Specified by:

listResponseInputItems in interface ArkBaseServiceImpl

uploadFile

public FileMeta uploadFile(UploadFileRequest request)

Specified by:

uploadFile in interface ArkBaseServiceImpl

retrieveFile

public FileMeta retrieveFile(String fileId)

Specified by:

retrieveFile in interface ArkBaseServiceImpl

deleteFile

public DeleteFileResponse deleteFile(String fileId)

Specified by:

deleteFile in interface ArkBaseServiceImpl

listFiles

public ListFilesResponse listFiles(ListFilesRequest request)

Specified by:

listFiles in interface ArkBaseServiceImpl

shutdownExecutor

public void shutdownExecutor()

builder

public static ArkService.Builder builder()