Clarify Documentation for OpenAI-Compatible Base Classes Used by Multiple Providers #95 #97
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
raftaar1191
changed the title
felixarntz
approved these changes
Sep 22, 2025
There was a problem hiding this comment.
@raftaar1191 Thank you! LGTM, with some minor iterations.
Great catch on the renamed method!
| public function exposePrepareMessagesParamWithSystemInstruction(array $prompt, string $systemInstruction): array | ||
| { | ||
| return $this->mergeSystemInstruction($prompt, $systemInstruction); | ||
| return $this->prepareMessagesParam($prompt, $systemInstruction); |
src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleImageGenerationModel.php
Outdated
Show resolved
Hide resolved
src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleModelMetadataDirectory.php
Outdated
Show resolved
Hide resolved
src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleTextGenerationModel.php
Outdated
Show resolved
Hide resolved
tests/unit/Providers/OpenAiCompatibleImplementation/MockOpenAiCompatibleTextGenerationModel.php
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the documentation for the abstract base classes in the OpenAiCompatibleImplementation namespace. The updated docblocks now clearly state that these classes are designed for any provider implementing the OpenAI API format—not just OpenAI, but also Anthropic, Google, and others who offer OpenAI-compatible endpoints.
No functional code changes were made; only comments and docblocks were updated for clarity.
This resolves confusion for contributors and maintainers, making it explicit that these base classes are intended for multi-provider use, following the OpenAI API specification as a standard interface.
Notes:
Used AI assistance to update and clarify the documentation for these base classes. No functional code changes were made.