Package io.github.stefanbratanov.jvm.openai

Class ChatClient

java.lang.Object

io.github.stefanbratanov.jvm.openai.ChatClient

public final class ChatClient
extends Object

Given a list of messages comprising a conversation, the model will return a response.

Based on Chat

Method Summary

Modifier and Type	Method	Description
ChatCompletion	createChatCompletion(CreateChatCompletionRequest request)	Creates a model response for the given chat conversation.
CompletableFuture<ChatCompletion>	createChatCompletionAsync(CreateChatCompletionRequest request)	Same as createChatCompletion(CreateChatCompletionRequest) but returns a response in a CompletableFuture
Stream<ChatCompletionChunk>	streamChatCompletion(CreateChatCompletionRequest request)	Stream model responses back in order to allow partial results for the given request.
void	streamChatCompletion(CreateChatCompletionRequest request, StreamChatCompletionSubscriber subscriber)	Same as streamChatCompletion(CreateChatCompletionRequest) but can pass a StreamChatCompletionSubscriber implementation instead of using a Stream<ChatCompletionChunk>

Methods inherited from class java.lang.Object

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

Method Details

createChatCompletion

public ChatCompletion createChatCompletion(CreateChatCompletionRequest request)

Creates a model response for the given chat conversation.

Throws:

OpenAIException - in case of API errors

createChatCompletionAsync

public CompletableFuture<ChatCompletion> createChatCompletionAsync(CreateChatCompletionRequest request)

Same as createChatCompletion(CreateChatCompletionRequest) but returns a response in a CompletableFuture

streamChatCompletion

public Stream<ChatCompletionChunk> streamChatCompletion(CreateChatCompletionRequest request)

Stream model responses back in order to allow partial results for the given request.

Parameters:

request - the request should be configured with CreateChatCompletionRequest.Builder.stream(boolean) set to true

Throws:

OpenAIException - in case of API errors

streamChatCompletion

public void streamChatCompletion(CreateChatCompletionRequest request,
 StreamChatCompletionSubscriber subscriber)

Same as streamChatCompletion(CreateChatCompletionRequest) but can pass a StreamChatCompletionSubscriber implementation instead of using a Stream<ChatCompletionChunk>