Support OpenAI embeddings endpoint (#408)

Author: kpavlov

README.md

@@ -161,7 +161,19 @@ It supports mocking following AI services:
 4. [Ollama](https://github.com/ollama/ollama/blob/main/docs/api.md) - [ai-mocks-ollama](https://mokksy.dev/docs/ai-mocks/ollama/)
 5. [Agent-to-Agent (A2A) Protocol](https://a2a-protocol.org/latest/specification/) - [ai-mocks-a2a](https://mokksy.dev/docs/ai-mocks/a2a/)
 
-**_NB! Not all API endpoints and parameters are supported!_**
+## Feature Support Matrix
+
+| Feature              | OpenAI    | Anthropic | Gemini | Ollama   | A2A                                  |
+|----------------------|-----------|-----------|--------|----------|--------------------------------------|
+| **Chat Completions** | ✅         | ✅         | ✅      | ✅        | ✅                                    |
+| **Streaming**        | ✅         | ✅         | ✅      | ✅        | ✅                                    |
+| **Embeddings**       | ✅         | ❌         | ❌      | ✅        | ❌                                    |
+| **Moderation**       | ✅         | ❌         | ❌      | ❌        | ❌                                    |
+| **Additional APIs**  | Responses | -         | -      | Generate | Full A2A Protocol<br/>(11 endpoints) |
+
+
+## Enjoying LLM integration testing? ❤️
+[![Buy me a Coffee](https://cdn.buymeacoffee.com/buttons/default-orange.png)](https://buymeacoffee.com/mailsk)
 
 ## How to build
 
@@ -181,6 +193,3 @@ make
 
 I do welcome contributions! Please see the [Contributing Guidelines](CONTRIBUTING.md) for details.
 
-## Enjoying LLM integration testing? :heart:
-
-[![Buy me a Coffee](https://cdn.buymeacoffee.com/buttons/default-orange.png)](https://buymeacoffee.com/mailsk)

ai-mocks-ollama/src/commonMain/kotlin/me/kpavlov/aimocks/ollama/MockOllama.kt

@@ -15,7 +15,6 @@ import me.kpavlov.aimocks.ollama.generate.GenerateRequest
 import me.kpavlov.aimocks.ollama.generate.OllamaGenerateBuildingStep
 import me.kpavlov.aimocks.ollama.generate.OllamaGenerateRequestSpecification
 import me.kpavlov.mokksy.ServerConfiguration
-import java.util.function.Consumer
 
 /**
  * Mock implementation of an Ollama-compatible service for testing purposes.
@@ -47,21 +46,6 @@ public open class MockOllama(
                 )
             },
     ) {
-    /**
-     * Configures a mock `/api/generate` endpoint using a Java `Consumer` to specify the request criteria.
-     *
-     * This overload enables Java interoperability for setting up request matching
-     * and response configuration for the generate API.
-     *
-     * @param name An optional name for the mock configuration.
-     * @param block A Java `Consumer` that configures the generate request specification.
-     * @return A building step for further response configuration.
-     */
-    @JvmOverloads
-    public fun generate(
-        name: String? = null,
-        block: Consumer<OllamaGenerateRequestSpecification>,
-    ): OllamaGenerateBuildingStep = generate(name) { block.accept(this) }
 
     /**
      * Sets up a mock handler for the Ollama `/api/generate` completion endpoint.
@@ -111,19 +95,6 @@ public open class MockOllama(
         )
     }
 
-    /**
-     * Provides a Java-compatible overload for configuring a mock Ollama chat request using a Consumer.
-     *
-     * @param name An optional name for the mock configuration.
-     * @param block A Consumer that configures the chat request specification.
-     * @return A building step for further configuration of the mock chat response.
-     */
-    @JvmOverloads
-    public fun chat(
-        name: String? = null,
-        block: Consumer<OllamaChatRequestSpecification>,
-    ): OllamaChatBuildingStep = chat(name) { block.accept(this) }
-
     /**
      * Sets up a mock handler for the Ollama chat completion (`/api/chat`) endpoint.
      *
@@ -181,21 +152,6 @@ public open class MockOllama(
         )
     }
 
-    /**
-     * Provides a Java-compatible overload for configuring a mock `/api/embed` endpoint using a Consumer.
-     *
-     * Allows Java code to specify the embedding request specification for the mock Ollama embed API.
-     *
-     * @param name Optional name for the mock configuration.
-     * @param block Consumer that configures the embedding request specification.
-     * @return A building step for further response configuration.
-     */
-    @JvmOverloads
-    public fun embed(
-        name: String? = null,
-        block: Consumer<OllamaEmbedRequestSpecification>,
-    ): OllamaEmbedBuildingStep = embed(name) { block.accept(this) }
-
     /**
      * Sets up a mock handler for the Ollama `/api/embed` endpoint,
      * allowing configuration of request matching for embedding requests.

ai-mocks-ollama/src/jvmMain/kotlin/me/kpavlov/aimocks/ollama/MockOllama.jvm.kt

@@ -0,0 +1,54 @@
+package me.kpavlov.aimocks.ollama
+
+import me.kpavlov.aimocks.ollama.chat.OllamaChatBuildingStep
+import me.kpavlov.aimocks.ollama.chat.OllamaChatRequestSpecification
+import me.kpavlov.aimocks.ollama.embed.OllamaEmbedBuildingStep
+import me.kpavlov.aimocks.ollama.embed.OllamaEmbedRequestSpecification
+import me.kpavlov.aimocks.ollama.generate.OllamaGenerateBuildingStep
+import me.kpavlov.aimocks.ollama.generate.OllamaGenerateRequestSpecification
+import java.util.function.Consumer
+
+/**
+ * Provides a Java-compatible overload for configuring a mock Ollama chat request using a Consumer.
+ *
+ * @param name An optional name for the mock configuration.
+ * @param block A Consumer that configures the chat request specification.
+ * @return A building step for further configuration of the mock chat response.
+ */
+@JvmOverloads
+public fun MockOllama.chat(
+    name: String? = null,
+    block: Consumer<OllamaChatRequestSpecification>,
+): OllamaChatBuildingStep = chat(name) { block.accept(this) }
+
+/**
+ * Configures a mock `/api/generate` endpoint using a Java `Consumer` to specify the request criteria.
+ *
+ * This overload enables Java interoperability for setting up request matching
+ * and response configuration for the generate API.
+ *
+ * @param name An optional name for the mock configuration.
+ * @param block A Java `Consumer` that configures the generate request specification.
+ * @return A building step for further response configuration.
+ */
+@JvmOverloads
+public fun MockOllama.generate(
+    name: String? = null,
+    block: Consumer<OllamaGenerateRequestSpecification>,
+): OllamaGenerateBuildingStep = generate(name) { block.accept(this) }
+
+
+/**
+ * Provides a Java-compatible overload for configuring a mock `/api/embed` endpoint using a Consumer.
+ *
+ * Allows Java code to specify the embedding request specification for the mock Ollama embed API.
+ *
+ * @param name Optional name for the mock configuration.
+ * @param block Consumer that configures the embedding request specification.
+ * @return A building step for further response configuration.
+ */
+@JvmOverloads
+public fun MockOllama.embed(
+    name: String? = null,
+    block: Consumer<OllamaEmbedRequestSpecification>,
+): OllamaEmbedBuildingStep = embed(name) { block.accept(this) }

ai-mocks-openai/src/commonMain/kotlin/me/kpavlov/aimocks/openai/MockOpenai.kt

@@ -1,11 +1,15 @@
 package me.kpavlov.aimocks.openai
 
 import io.kotest.assertions.json.containJsonKeyValue
+import io.kotest.matchers.string.contain
 import io.ktor.serialization.kotlinx.json.json
 import kotlinx.serialization.json.Json
 import me.kpavlov.aimocks.core.AbstractMockLlm
 import me.kpavlov.aimocks.openai.completions.OpenaiChatCompletionRequestSpecification
 import me.kpavlov.aimocks.openai.completions.OpenaiChatCompletionsBuildingStep
+import me.kpavlov.aimocks.openai.embeddings.OpenaiEmbedBuildingStep
+import me.kpavlov.aimocks.openai.embeddings.OpenaiEmbedRequestSpecification
+import me.kpavlov.aimocks.openai.model.embeddings.CreateEmbeddingsRequest
 import me.kpavlov.aimocks.openai.model.moderation.CreateModerationRequest
 import me.kpavlov.aimocks.openai.model.responses.CreateResponseRequest
 import me.kpavlov.aimocks.openai.moderation.OpenaiModerationBuildingStep
@@ -25,6 +29,7 @@ import java.util.function.Consumer
  * @param port The port on which the mock server will run. Defaults to 0, which allows the server to select
  *             an available port.
  * @param verbose Controls whether the mock server's operations are logged in detail. Defaults to true.
+ * @see <a href="https://platform.openai.com/docs/api-reference">OpenAI API Reference</a>
  * @author Konstantin Pavlov
  */
 public open class MockOpenai(
@@ -51,6 +56,19 @@ public open class MockOpenai(
         block: Consumer<OpenaiChatCompletionRequestSpecification>,
     ): OpenaiChatCompletionsBuildingStep = completion(name) { block.accept(this) }
 
+    /**
+     * Configures and constructs a mock handler for the OpenAI `/v1/chat/completions` endpoint.
+     *
+     * This method allows you to define specifications and criteria for chat completion requests,
+     * enabling controlled responses for testing and simulations.
+     *
+     * @param name An optional identifier for the mock configuration. Defaults to `null` if not provided.
+     * @param block A lambda function to configure the specifications for the chat completion request,
+     *              using the `OpenaiChatCompletionRequestSpecification` object.
+     * @return An instance of `OpenaiChatCompletionsBuildingStep`, representing a builder step
+     *         for configuring mock response behavior.
+     * @see <a href="https://platform.openai.com/docs/api-reference/chat/create">Create Chat Completion</a>
+     */
     public fun completion(
         name: String? = null,
         block: OpenaiChatCompletionRequestSpecification.() -> Unit,
@@ -94,6 +112,17 @@ public open class MockOpenai(
         )
     }
 
+    /**
+     * Sets up a mock handler for the OpenAI `/v1/responses` endpoint,
+     * allowing configuration of request matching for response generation requests.
+     *
+     * This endpoint is used to generate responses based on input files and instructions.
+     *
+     * @param name Optional identifier for the mock configuration.
+     * @param block Lambda to configure the request matching criteria.
+     * @return A builder step for specifying the mock response to response generation requests.
+     * @see <a href="https://platform.openai.com/docs/api-reference/responses/create">OpenAI Responses API</a>
+     */
     public fun responses(
         name: String? = null,
         block: OpenaiResponsesRequestSpecification.() -> Unit,
@@ -133,12 +162,30 @@ public open class MockOpenai(
         )
     }
 
+    /**
+     * Java-friendly overload that accepts a Consumer for configuring the moderation request.
+     *
+     * @param name Optional identifier for the mock configuration.
+     * @param block Consumer to configure the request matching criteria.
+     * @return A builder step for specifying the mock response to moderation requests.
+     */
     @JvmOverloads
     public fun moderation(
         name: String? = null,
         block: Consumer<OpenaiModerationRequestSpecification>,
     ): OpenaiModerationBuildingStep = moderation(name) { block.accept(this) }
 
+    /**
+     * Sets up a mock handler for the OpenAI `/v1/moderations` endpoint,
+     * allowing configuration of request matching for moderation requests.
+     *
+     * This endpoint classifies if input text or images violate OpenAI's usage policies.
+     *
+     * @param name Optional identifier for the mock configuration.
+     * @param block Lambda to configure the request matching criteria.
+     * @return A builder step for specifying the mock response to moderation requests.
+     * @see <a href="https://platform.openai.com/docs/api-reference/moderations/create">OpenAI Moderations API</a>
+     */
     public fun moderation(
         name: String? = null,
         block: OpenaiModerationRequestSpecification.() -> Unit,
@@ -170,5 +217,82 @@ public open class MockOpenai(
         )
     }
 
+    /**
+     * Java-friendly overload that accepts a Consumer for configuring the embedding request.
+     *
+     * @param name Optional identifier for the mock configuration.
+     * @param block Consumer to configure the request matching criteria.
+     * @return A builder step for specifying the mock response to embedding requests.
+     */
+    @JvmOverloads
+    public fun embeddings(
+        name: String? = null,
+        block: Consumer<OpenaiEmbedRequestSpecification>,
+    ): OpenaiEmbedBuildingStep = embeddings(name) { block.accept(this) }
+
+    /**
+     * Sets up a mock handler for the OpenAI `/v1/embeddings` endpoint,
+     * allowing configuration of request matching for embedding requests.
+     *
+     * Supports matching on model, input (string or list), dimensions, encoding_format,
+     * and user fields in the request body.
+     *
+     * @param name Optional identifier for the mock configuration.
+     * @param block Lambda to configure the request matching criteria.
+     * @return A builder step for specifying the mock response to embedding requests.
+     * @see <a href="https://platform.openai.com/docs/api-reference/embeddings/create">OpenAI Embeddings API</a>
+     */
+    @JvmOverloads
+    public fun embeddings(
+        name: String? = null,
+        block: OpenaiEmbedRequestSpecification.() -> Unit,
+    ): OpenaiEmbedBuildingStep {
+        val requestStep =
+            mokksy.post(
+                name = name,
+                requestType = CreateEmbeddingsRequest::class,
+            ) {
+                val embedRequestSpec = OpenaiEmbedRequestSpecification()
+                block(embedRequestSpec)
+
+                path("/v1/embeddings")
+
+                embedRequestSpec.model?.let {
+                    bodyString += containJsonKeyValue("model", it)
+                }
+
+                // Handle string input
+                embedRequestSpec.stringInput?.let {
+                    bodyString += containJsonKeyValue("input", it)
+                }
+
+                // Handle string list input
+                embedRequestSpec.stringListInput?.let {
+                    // For list inputs, we can't use containJsonKeyValue directly.
+                    // Instead, we'll check that the request body contains the input values
+                    it.forEach { inputValue ->
+                        bodyString += contain(inputValue)
+                    }
+                }
+
+                embedRequestSpec.user?.let {
+                    bodyString += containJsonKeyValue("user", it)
+                }
+
+                embedRequestSpec.requestBodyString.forEach {
+                    bodyString += contain(it)
+                }
+            }
+
+        return OpenaiEmbedBuildingStep(
+            buildingStep = requestStep,
+            mokksy = mokksy,
+        )
+    }
+
+    public fun MockOpenai.moderation(
+        block: Consumer<OpenaiModerationRequestSpecification>,
+    ): OpenaiModerationBuildingStep = moderation(block)
+
     override fun baseUrl(): String = "http://localhost:${port()}/v1"
 }