Clarify OpenAI-Compatible Base Class Documentation for Multi-Provider Support WordPress#95

Author: raftaar1191

src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleImageGenerationModel.php

@@ -24,7 +24,11 @@
 use WordPress\AiClient\Results\Enums\FinishReasonEnum;
 
 /**
- * Base class for an image generation model for an OpenAI compatible provider.
+ * Base class for an image generation model for providers that implement OpenAI's API format.
+ *
+ * This abstract class is designed to work with any AI provider that offers an OpenAI-compatible
+ * API endpoint for image generation, including but not limited to OpenAI, Google, and other
+ * providers that have adopted OpenAI's image generation API specification as a standard interface.
  *
  * @since 0.1.0
  *

src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleModelMetadataDirectory.php

@@ -13,7 +13,11 @@
 use WordPress\AiClient\Providers\Models\DTO\ModelMetadata;
 
 /**
- * Base class for a model metadata directory for an OpenAI compatible provider.
+ * Base class for a model metadata directory for providers that implement OpenAI's API format.
+ *
+ * This abstract class is designed to work with any AI provider that offers an OpenAI-compatible
+ * models listing endpoint, including but not limited to OpenAI, Anthropic, Google, and other
+ * providers that have adopted OpenAI's models API specification as a standard interface.
  *
  * @since 0.1.0
  */

src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleTextGenerationModel.php

@@ -27,7 +27,11 @@
 use WordPress\AiClient\Tools\DTO\FunctionDeclaration;
 
 /**
- * Base class for a text generation model for an OpenAI compatible provider.
+ * Base class for a text generation model for providers that implement OpenAI's API format.
+ *
+ * This abstract class is designed to work with any AI provider that offers an OpenAI-compatible
+ * API endpoint, including but not limited to OpenAI, Anthropic, Google, and other providers
+ * that have adopted OpenAI's API specification as a standard interface.
  *
  * @since 0.1.0
  *

tests/mocks/MockOpenAiCompatibleImageGenerationModel.php

@@ -14,6 +14,9 @@
 
 /**
  * Mock class for AbstractOpenAiCompatibleImageGenerationModel to expose protected methods for testing.
+ *
+ * This mock represents an image generation model that implements OpenAI's API format,
+ * which can be used by any AI provider offering OpenAI-compatible endpoints.
  */
 class MockOpenAiCompatibleImageGenerationModel extends AbstractOpenAiCompatibleImageGenerationModel
 {

tests/unit/Providers/OpenAiCompatibleImplementation/MockOpenAiCompatibleTextGenerationModel.php

@@ -20,6 +20,9 @@
 
 /**
  * Mock class for testing AbstractOpenAiCompatibleTextGenerationModel.
+ *
+ * This mock represents a text generation model that implements OpenAI's API format,
+ * which can be used by any AI provider offering OpenAI-compatible endpoints.
  */
 class MockOpenAiCompatibleTextGenerationModel extends AbstractOpenAiCompatibleTextGenerationModel
 {
@@ -113,9 +116,9 @@ public function exposePrepareGenerateTextParams(array $prompt): array
         return $this->prepareGenerateTextParams($prompt);
     }
 
-    public function exposeMergeSystemInstruction(array $prompt, string $systemInstruction): array
+    public function exposePrepareMessagesParamWithSystemInstruction(array $prompt, string $systemInstruction): array
     {
-        return $this->mergeSystemInstruction($prompt, $systemInstruction);
+        return $this->prepareMessagesParam($prompt, $systemInstruction);
     }
 
     public function exposePrepareMessagesParam(array $messages): array