Merge pull request #97 from raftaar1191/issue-95

felixarntz · web-flow · commit f6b6e8dc7fd0 · 2025-09-21T17:36:39.000-07:00
Clarify Documentation for OpenAI-Compatible Base Classes Used by Multiple Providers #95
diff --git a/src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleImageGenerationModel.php b/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 Anthropic, Google, and other
+ * providers that have adopted OpenAI's image generation API specification as a standard interface.
  *
  * @since 0.1.0
  *
diff --git a/src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleModelMetadataDirectory.php b/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 Anthropic, Google, and other
+ * providers that have adopted OpenAI's models API specification as a standard interface.
  *
  * @since 0.1.0
  */
diff --git a/src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleTextGenerationModel.php b/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 Anthropic, Google, and other providers
+ * that have adopted OpenAI's API specification as a standard interface.
  *
  * @since 0.1.0
  *
diff --git a/tests/unit/Providers/OpenAiCompatibleImplementation/MockOpenAiCompatibleTextGenerationModel.php b/tests/unit/Providers/OpenAiCompatibleImplementation/MockOpenAiCompatibleTextGenerationModel.php
@@ -113,9 +113,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

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,11 @@`
`24`	`24`	`use WordPress\AiClient\Results\Enums\FinishReasonEnum;`
`25`	`25`
`26`	`26`	`/**`
`27`		`- * Base class for an image generation model for an OpenAI compatible provider.`
	`27`	`+ * Base class for an image generation model for providers that implement OpenAI's API format.`
	`28`	`+ *`
	`29`	`+ * This abstract class is designed to work with any AI provider that offers an OpenAI-compatible`
	`30`	`+ * API endpoint for image generation, including but not limited to Anthropic, Google, and other`
	`31`	`+ * providers that have adopted OpenAI's image generation API specification as a standard interface.`
`28`	`32`	`*`
`29`	`33`	`* @since 0.1.0`
`30`	`34`	`*`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,11 @@`
`27`	`27`	`use WordPress\AiClient\Tools\DTO\FunctionDeclaration;`
`28`	`28`
`29`	`29`	`/**`
`30`		`- * Base class for a text generation model for an OpenAI compatible provider.`
	`30`	`+ * Base class for a text generation model for providers that implement OpenAI's API format.`
	`31`	`+ *`
	`32`	`+ * This abstract class is designed to work with any AI provider that offers an OpenAI-compatible`
	`33`	`+ * API endpoint, including but not limited to Anthropic, Google, and other providers`
	`34`	`+ * that have adopted OpenAI's API specification as a standard interface.`
`31`	`35`	`*`
`32`	`36`	`* @since 0.1.0`
`33`	`37`	`*`
Original file line number	Diff line number	Diff line change
`@@ -113,9 +113,9 @@ public function exposePrepareGenerateTextParams(array $prompt): array`
`113`	`113`	`return $this->prepareGenerateTextParams($prompt);`
`114`	`114`	`}`
`115`	`115`
`116`		`- public function exposeMergeSystemInstruction(array $prompt, string $systemInstruction): array`
	`116`	`+ public function exposePrepareMessagesParamWithSystemInstruction(array $prompt, string $systemInstruction): array`
`117`	`117`	`{`
`118`		`- return $this->mergeSystemInstruction($prompt, $systemInstruction);`
	`118`	`+ return $this->prepareMessagesParam($prompt, $systemInstruction);`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`public function exposePrepareMessagesParam(array $messages): array`