ai-mocks-openai/dev.mokksy.aimocks.openai.completions/OpenaiChatCompletionsBuildingStep

OpenaiChatCompletionsBuildingStep

class OpenaiChatCompletionsBuildingStep(mokksy: MokksyServer, buildingStep: BuildingStep<ChatCompletionRequest>) : AbstractBuildingStep<ChatCompletionRequest, OpenaiChatResponseSpecification> (source)

OpenaiChatCompletionsBuildingStep is a specialized implementation of AbstractBuildingStep intended for constructing and managing chat completion responses as part of the OpenAI Mock Server setup.

The class provides features to create both single-blocked responses and streaming responses for simulated chat completions using mock data. It extends the functionality of AbstractBuildingStep by applying specific logic for generating fake responses compliant with OpenAI's chat completion API.

Author

Konstantin Pavlov

Parameters

mokksy

The mock server instance used for handling mock request and response lifecycle.

buildingStep

The underlying building step for managing and supporting response configurations for OpenAI Chat Completion requests.

Constructors

OpenaiChatCompletionsBuildingStep

constructor(mokksy: MokksyServer, buildingStep: BuildingStep<ChatCompletionRequest>)

Initializes the building step with the provided mock server instance and a higher-level building step for configuring chat completion responses.

Functions

responds

open infix fun responds(block: Consumer<OpenaiChatResponseSpecification>)

open infix override fun responds(block: suspend OpenaiChatResponseSpecification.() -> Unit)

respondsError

open infix fun <R : Any> respondsError(block: Consumer<ResponseDefinitionBuilder<ChatCompletionRequest, R>>)

open infix fun <T : Any> respondsError(block: suspend ResponseDefinitionBuilder<ChatCompletionRequest, T>.() -> Unit)

open fun <T : Any> respondsError(responseType: KClass<T>, block: suspend ResponseDefinitionBuilder<ChatCompletionRequest, T>.() -> Unit)

respondsStream

infix fun respondsStream(block: OpenaiStreamingChatResponseSpecification.() -> Unit)

Configures a streaming response for a chat completions request by applying the provided specifications.

OpenaiChatCompletionsBuildingStep

Author

Parameters

See also

Constructors

Functions