dev.ai4j.openai4j

Class OpenAiClient

java.lang.Object

dev.ai4j.openai4j.OpenAiClient

Direct Known Subclasses:

DefaultOpenAiClient

public abstract class OpenAiClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenAiClient.Builder<T extends OpenAiClient,B extends OpenAiClient.Builder<T,B>>
static class	OpenAiClient.OpenAiClientContext

Constructor Summary

Constructors

Constructor and Description
OpenAiClient()

Method Summary

Modifier and Type	Method and Description
static OpenAiClient.Builder	builder()
SyncOrAsyncOrStreaming<ChatCompletionResponse>	chatCompletion(ChatCompletionRequest request)
SyncOrAsyncOrStreaming<ChatCompletionResponse>	chatCompletion(OpenAiClient.OpenAiClientContext clientContext, ChatCompletionRequest request)
SyncOrAsyncOrStreaming<String>	chatCompletion(OpenAiClient.OpenAiClientContext clientContext, String userMessage)
SyncOrAsyncOrStreaming<String>	chatCompletion(String userMessage)
SyncOrAsyncOrStreaming<CompletionResponse>	completion(CompletionRequest request)
SyncOrAsyncOrStreaming<CompletionResponse>	completion(OpenAiClient.OpenAiClientContext clientContext, CompletionRequest request)
SyncOrAsyncOrStreaming<String>	completion(OpenAiClient.OpenAiClientContext clientContext, String prompt)
SyncOrAsyncOrStreaming<String>	completion(String prompt)
SyncOrAsync<EmbeddingResponse>	embedding(EmbeddingRequest request)
SyncOrAsync<EmbeddingResponse>	embedding(OpenAiClient.OpenAiClientContext clientContext, EmbeddingRequest request)
SyncOrAsync<List<Float>>	embedding(OpenAiClient.OpenAiClientContext clientContext, String input)
SyncOrAsync<List<Float>>	embedding(String input)
SyncOrAsync<GenerateImagesResponse>	imagesGeneration(GenerateImagesRequest request)
SyncOrAsync<GenerateImagesResponse>	imagesGeneration(OpenAiClient.OpenAiClientContext clientContext, GenerateImagesRequest request)
SyncOrAsync<ModerationResponse>	moderation(ModerationRequest request)
SyncOrAsync<ModerationResponse>	moderation(OpenAiClient.OpenAiClientContext clientContext, ModerationRequest request)
SyncOrAsync<ModerationResult>	moderation(OpenAiClient.OpenAiClientContext clientContext, String input)
SyncOrAsync<ModerationResult>	moderation(String input)
abstract void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenAiClient

public OpenAiClient()

Method Detail

completion

public SyncOrAsyncOrStreaming<CompletionResponse> completion(CompletionRequest request)

completion

public SyncOrAsyncOrStreaming<CompletionResponse> completion(OpenAiClient.OpenAiClientContext clientContext,
                                                             CompletionRequest request)

completion

public SyncOrAsyncOrStreaming<String> completion(String prompt)

completion

public SyncOrAsyncOrStreaming<String> completion(OpenAiClient.OpenAiClientContext clientContext,
                                                 String prompt)

chatCompletion

public SyncOrAsyncOrStreaming<ChatCompletionResponse> chatCompletion(ChatCompletionRequest request)

chatCompletion

public SyncOrAsyncOrStreaming<ChatCompletionResponse> chatCompletion(OpenAiClient.OpenAiClientContext clientContext,
                                                                     ChatCompletionRequest request)

chatCompletion

public SyncOrAsyncOrStreaming<String> chatCompletion(String userMessage)

chatCompletion

public SyncOrAsyncOrStreaming<String> chatCompletion(OpenAiClient.OpenAiClientContext clientContext,
                                                     String userMessage)

embedding

public SyncOrAsync<EmbeddingResponse> embedding(EmbeddingRequest request)

embedding

public SyncOrAsync<EmbeddingResponse> embedding(OpenAiClient.OpenAiClientContext clientContext,
                                                EmbeddingRequest request)

embedding

public SyncOrAsync<List<Float>> embedding(String input)

embedding

public SyncOrAsync<List<Float>> embedding(OpenAiClient.OpenAiClientContext clientContext,
                                          String input)

moderation

public SyncOrAsync<ModerationResponse> moderation(ModerationRequest request)

moderation

public SyncOrAsync<ModerationResponse> moderation(OpenAiClient.OpenAiClientContext clientContext,
                                                  ModerationRequest request)

moderation

public SyncOrAsync<ModerationResult> moderation(String input)

moderation

public SyncOrAsync<ModerationResult> moderation(OpenAiClient.OpenAiClientContext clientContext,
                                                String input)

imagesGeneration

public SyncOrAsync<GenerateImagesResponse> imagesGeneration(GenerateImagesRequest request)

imagesGeneration

public SyncOrAsync<GenerateImagesResponse> imagesGeneration(OpenAiClient.OpenAiClientContext clientContext,
                                                            GenerateImagesRequest request)

shutdown

public abstract void shutdown()

builder

public static OpenAiClient.Builder builder()