ai-mocks-openai/dev.mokksy.aimocks.openai/MockOpenai

MockOpenai

open class MockOpenai(port: Int = 0, verbose: Boolean = true) : AbstractMockLlm(source)

Mock implementation of an OpenAI-compatible service for testing purposes.

This class provides an HTTP mock server to simulate OpenAI APIs, specifically for chat completions and response generation. It is designed to mimic the behavior of the OpenAI APIs locally and facilitate integration testing and development.

Extends AbstractMockLlm to provide OpenAI-specific functionality.

Author

Konstantin Pavlov

Parameters

port

The port on which the mock server will run. Defaults to 0, which allows the server to select an available port.

verbose

Controls whether the mock server's operations are logged in detail. Defaults to true.

Constructors

MockOpenai

constructor(port: Int = 0, verbose: Boolean = true)

Functions

baseUrl

open override fun baseUrl(): String

completion

@JvmOverloads

fun completion(name: String? = null, block: Consumer<OpenaiChatCompletionRequestSpecification>): OpenaiChatCompletionsBuildingStep

Java-friendly overload that accepts a Consumer for configuring the chat request.

fun completion(name: String? = null, block: OpenaiChatCompletionRequestSpecification.() -> Unit): OpenaiChatCompletionsBuildingStep

Configures and constructs a mock handler for the OpenAI /v1/chat/completions endpoint.

embeddings

@JvmOverloads

fun embeddings(name: String? = null, block: Consumer<OpenaiEmbedRequestSpecification>): OpenaiEmbedBuildingStep

Java-friendly overload that accepts a Consumer for configuring the embedding request.

@JvmOverloads

fun embeddings(name: String? = null, block: OpenaiEmbedRequestSpecification.() -> Unit): OpenaiEmbedBuildingStep

Sets up a mock handler for the OpenAI /v1/embeddings endpoint, allowing configuration of request matching for embedding requests.

moderation

fun MockOpenai.moderation(block: Consumer<OpenaiModerationRequestSpecification>): OpenaiModerationBuildingStep

@JvmOverloads

fun moderation(name: String? = null, block: Consumer<OpenaiModerationRequestSpecification>): OpenaiModerationBuildingStep

Java-friendly overload that accepts a Consumer for configuring the moderation request.

fun moderation(name: String? = null, block: OpenaiModerationRequestSpecification.() -> Unit): OpenaiModerationBuildingStep

Sets up a mock handler for the OpenAI /v1/moderations endpoint, allowing configuration of request matching for moderation requests.

port

fun port(): Int

resetMatchState

fun resetMatchState()

responses

fun responses(name: String? = null, block: OpenaiResponsesRequestSpecification.() -> Unit): OpenaiResponsesBuildingStep

Sets up a mock handler for the OpenAI /v1/responses endpoint, allowing configuration of request matching for response generation requests.

shutdown

@JvmOverloads

open fun shutdown(gracePeriodMillis: Long, timeoutMillis: Long)

verifyNoUnexpectedRequests

fun verifyNoUnexpectedRequests()

verifyNoUnmatchedRequests

fun ~~verifyNoUnmatchedRequests~~()

MockOpenai

Author

Parameters

See also

Constructors

Functions