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

OpenaiChatCompletionRequestSpecification

open class OpenaiChatCompletionRequestSpecification(var seed: Int? = null) : AbstractInferenceRequestSpecification<ChatCompletionRequest> (source)

Represents the specification for an OpenAI chat completion request.

Extends ModelRequestSpecification specifically for configuring and validating parameters related to ChatCompletionRequest objects. This includes overriding methods to add matchers for specific conditions such as ensuring messages from the system or user contain specified substrings.

Author

Konstantin Pavlov

See also

Create Chat Completion

Constructors

OpenaiChatCompletionRequestSpecification

constructor(seed: Int? = null)

Creates an instance with optional parameters for initializing configuration.

Properties

var maxTokens: Long?

var model: String?

val requestBody: MutableList<Matcher<ChatCompletionRequest?>>

requestBodyString

val requestBodyString: MutableList<Matcher<String?>>

var seed: Int?

An optional seed value for deterministic behavior in chat completions.

var temperature: Double?

var topK: Long?

var topP: Double?

Functions

hasToolWithFunction

fun hasToolWithFunction(functionName: String)

Adds a matcher to verify that the request includes a tool with the specified function name.

fun maxTokens(value: Long): AbstractInferenceRequestSpecification<ChatCompletionRequest>

fun maxTokens(value: Number): AbstractInferenceRequestSpecification<ChatCompletionRequest>

fun model(model: String): ModelRequestSpecification<ChatCompletionRequest>

requestBodyContains

fun requestBodyContains(substring: String): ModelRequestSpecification<ChatCompletionRequest>

requestBodyContainsIgnoringCase

fun requestBodyContainsIgnoringCase(substring: String): ModelRequestSpecification<ChatCompletionRequest>

requestBodyDoesNotContains

fun requestBodyDoesNotContains(substring: String): ModelRequestSpecification<ChatCompletionRequest>

requestBodyDoesNotContainsIgnoringCase

fun requestBodyDoesNotContainsIgnoringCase(substring: String): ModelRequestSpecification<ChatCompletionRequest>

requestBodyEquals

fun requestBodyEquals(requestObject: ChatCompletionRequest): ModelRequestSpecification<ChatCompletionRequest>

fun requestBodyEquals(payload: String): ModelRequestSpecification<ChatCompletionRequest>

requestBodyEqualsJson

fun requestBodyEqualsJson(payload: String): ModelRequestSpecification<ChatCompletionRequest>

fun requestMatches(matcher: Matcher<ChatCompletionRequest?>)

requestMatchesPredicate

fun requestMatchesPredicate(predicate: (ChatCompletionRequest) -> Boolean)

requestSatisfies

fun requestSatisfies(description: String?, call: (ChatCompletionRequest?) -> Unit)

fun seed(value: Int): OpenaiChatCompletionRequestSpecification

Sets the seed value for deterministic behavior in chat completions.

systemMessageContains

inline fun systemMessageContains(builderAction: StringBuilder.() -> Unit)

open override fun systemMessageContains(substring: String)

fun temperature(temperature: Double): AbstractInferenceRequestSpecification<ChatCompletionRequest>

toolHasParameter

fun toolHasParameter(functionName: String, parameterName: String)

Adds a matcher to verify that a tool's function has a parameter with the specified name.

fun toolHasParameter(functionName: String, parameterName: String, description: String)

Adds a matcher to verify that a tool's function has a parameter with the specified name and description.

toolParameterHasType

fun toolParameterHasType(functionName: String, parameterName: String, expectedType: String)

Adds a matcher to verify that a tool's function parameter has the specified type.

toolRequiresParameters

fun toolRequiresParameters(functionName: String, vararg requiredParams: String)

Adds a matcher to verify that a tool's function requires specific parameters.

fun topK(value: Long): AbstractInferenceRequestSpecification<ChatCompletionRequest>

fun topK(value: Number): AbstractInferenceRequestSpecification<ChatCompletionRequest>

fun topP(value: Double): AbstractInferenceRequestSpecification<ChatCompletionRequest>

fun topP(value: Number): AbstractInferenceRequestSpecification<ChatCompletionRequest>

userMessageContains

inline fun userMessageContains(builderAction: StringBuilder.() -> Unit)

open override fun userMessageContains(substring: String)