commonMain.com.aallam.openai.client.Chat.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openai-client Show documentation

OpenAI API Kotlin Client

The newest version!

package com.aallam.openai.client

import com.aallam.openai.api.chat.ChatCompletion
import com.aallam.openai.api.chat.ChatCompletionChunk
import com.aallam.openai.api.chat.ChatCompletionRequest
import com.aallam.openai.api.core.RequestOptions
import kotlinx.coroutines.flow.Flow

/**
 * Given a chat conversation, the model will return a chat completion response.
 */
public interface Chat {

    /**
     * Creates a completion for the chat message.
     *
     * @param request completion request.
     * @param requestOptions request options.
     */
    public suspend fun chatCompletion(
        request: ChatCompletionRequest,
        requestOptions: RequestOptions? = null
    ): ChatCompletion

    /**
     * Stream variant of [chatCompletion].
     *
     * @param request completion request.
     * @param requestOptions request options.
     */
    public fun chatCompletions(
        request: ChatCompletionRequest,
        requestOptions: RequestOptions? = null
    ): Flow
}