ChatGPT-Java-API/com.cjcrafter.openai/OpenAIImpl

OpenAIImpl

open class OpenAIImpl @ApiStatus.Internal constructor(apiKey: String, organization: String? = null, client: OkHttpClient = OkHttpClient(), baseUrl: String = "https://api.openai.com") : OpenAI

Inheritors

AzureOpenAI

Constructors

OpenAIImpl

@ApiStatus.Internal

constructor(apiKey: String, organization: String? = null, client: OkHttpClient = OkHttpClient(), baseUrl: String = "https://api.openai.com")

Types

Companion

object Companion

Functions

assistants

@ApiStatus.Experimental

@Contract(pure = true)

open fun assistants(): AssistantHandler

Returns the handler for the assistants endpoint. This method is purely syntactic sugar for Java users.

createChatCompletion

open override fun createChatCompletion(request: ChatRequest): ChatResponse

Calls the chat completions API endpoint. This method is blocking.

createCompletion

open override fun createCompletion(request: CompletionRequest): CompletionResponse

Calls the completions API endpoint. This method is blocking.

createEmbeddings

open override fun createEmbeddings(request: EmbeddingsRequest): EmbeddingsResponse

Calls the embeddings API endpoint to generate the vector representation of text. The returned vector can be used in Machine Learning models. This method is blocking.

files

@Contract(pure = true)

open fun files(): FileHandler

Returns the handler for the files endpoint. This method is purely syntactic sugar for Java users.

streamChatCompletion

open override fun streamChatCompletion(request: ChatRequest): Iterable<ChatResponseChunk>

Calls the chat completions API endpoint and streams each token 1 at a time for a faster response.

streamChatCompletion

fun OpenAI.streamChatCompletion(request: ChatRequest, consumer: (ChatResponseChunk) -> Unit)

Extension function to stream a chat completion using kotlin coroutines.

streamCompletion

open override fun streamCompletion(request: CompletionRequest): Iterable<CompletionResponseChunk>

Calls the completions API endpoint and streams each token 1 at a time for a faster response time.

streamCompletion

fun OpenAI.streamCompletion(request: CompletionRequest, consumer: (CompletionResponseChunk) -> Unit)

Extension function to stream a completion using kotlin coroutines.

threads

@ApiStatus.Experimental

@Contract(pure = true)

open fun threads(): ThreadHandler

Returns the handler for the threads endpoint. This method is purely syntactic sugar for Java users.

Properties

assistants

open override val assistants: AssistantHandler

Returns the handler for the assistants endpoint. This handler can be used to create, retrieve, and delete assistants.

files

open override val files: FileHandler

Returns the handler for the files endpoint. This handler can be used to create, retrieve, and delete files.

threads

open override val threads: ThreadHandler

Returns the handler for the threads endpoint. This handler can be used to create, retrieve, and delete threads.