Class OpenAiClient

java.lang.Object

dev.langchain4j.model.openai.internal.OpenAiClient

Direct Known Subclasses:

DefaultOpenAiClient

public abstract class OpenAiClient
extends Object

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_STREAMING_BUFFER_SIZE	Default size of the bounded back-pressure buffer used by the reactive streaming publisher (see chatCompletionPublisher); overridable per object via Builder#streamingBufferSize(int).

Constructor Summary

Constructors

Constructor	Description
OpenAiClient()

Method Summary

Modifier and Type	Method	Description
SyncOrAsync<OpenAiAudioTranscriptionResponse>	audioTranscription(OpenAiAudioTranscriptionRequest request)
static OpenAiClient.Builder	builder()
abstract SyncOrAsyncOrStreaming<ChatCompletionResponse>	chatCompletion(ChatCompletionRequest request)
Flow.Publisher<ChatModelStreamingEvent>	chatCompletionPublisher(ChatCompletionRequest request, ChatCompletionOptions options)
abstract SyncOrAsyncOrStreaming<CompletionResponse>	completion(CompletionRequest request)
abstract SyncOrAsync<EmbeddingResponse>	embedding(EmbeddingRequest request)
SyncOrAsync<GenerateImagesResponse>	imagesEdit(EditImageRequest request)
abstract SyncOrAsync<GenerateImagesResponse>	imagesGeneration(GenerateImagesRequest request)
SyncOrAsync<ModelsListResponse>	listModels()
abstract SyncOrAsync<ModerationResponse>	moderation(ModerationRequest request)
SyncOrAsync<OpenAiTextToSpeechResponse>	textToSpeech(OpenAiTextToSpeechRequest request)

Methods inherited from class Object

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

Field Details

DEFAULT_STREAMING_BUFFER_SIZE

public static final int DEFAULT_STREAMING_BUFFER_SIZE

Default size of the bounded back-pressure buffer used by the reactive streaming publisher (see chatCompletionPublisher); overridable per object via Builder#streamingBufferSize(int).

See Also:

• Constant Field Values

Constructor Details

OpenAiClient

public OpenAiClient()

Method Details

completion

public abstract SyncOrAsyncOrStreaming<CompletionResponse> completion(CompletionRequest request)

chatCompletion

public abstract SyncOrAsyncOrStreaming<ChatCompletionResponse> chatCompletion(ChatCompletionRequest request)

chatCompletionPublisher

@Experimental
public Flow.Publisher<ChatModelStreamingEvent> chatCompletionPublisher(ChatCompletionRequest request,
 ChatCompletionOptions options)

Returns:

a cold Flow.Publisher that streams the chat completion as ChatModelStreamingEvents.

Since:

1.20.0

embedding

public abstract SyncOrAsync<EmbeddingResponse> embedding(EmbeddingRequest request)

moderation

public abstract SyncOrAsync<ModerationResponse> moderation(ModerationRequest request)

imagesGeneration

public abstract SyncOrAsync<GenerateImagesResponse> imagesGeneration(GenerateImagesRequest request)

imagesEdit

public SyncOrAsync<GenerateImagesResponse> imagesEdit(EditImageRequest request)

audioTranscription

public SyncOrAsync<OpenAiAudioTranscriptionResponse> audioTranscription(OpenAiAudioTranscriptionRequest request)

textToSpeech

public SyncOrAsync<OpenAiTextToSpeechResponse> textToSpeech(OpenAiTextToSpeechRequest request)

listModels

public SyncOrAsync<ModelsListResponse> listModels()

builder

public static OpenAiClient.Builder builder()