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

Field Summary

Fields

Modifier and Type	Field	Description
protected final HttpClient	httpClient
protected final com.fasterxml.jackson.databind.ObjectMapper	objectMapper

Method Summary

Modifier and Type	Method	Description
ChatResponse	sendRequest(ChatRequest request)	Creates a model response for the given chat conversation.
CompletableFuture<ChatResponse>	sendRequestAsync(ChatRequest request)	Same as sendRequest(ChatRequest) but returns a response in a CompletableFuture
Stream<ChatChunkResponse>	sendStreamRequest(ChatRequest request)	Stream model responses back in order to allow partial results for the given request.

Methods inherited from class java.lang.Object

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

Field Details

httpClient

protected final HttpClient httpClient

objectMapper

protected final com.fasterxml.jackson.databind.ObjectMapper objectMapper

Method Details

sendRequest

public ChatResponse sendRequest(ChatRequest request)

Creates a model response for the given chat conversation.

Throws:

OpenAIException - in case of API errors

sendRequestAsync

public CompletableFuture<ChatResponse> sendRequestAsync(ChatRequest request)

Same as sendRequest(ChatRequest) but returns a response in a CompletableFuture

sendStreamRequest

public Stream<ChatChunkResponse> sendStreamRequest(ChatRequest request)

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

Parameters:

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

Throws:

OpenAIException - in case of API errors