Skip to content

Clarify Documentation for OpenAI-Compatible Base Classes Used by Multiple Providers #95 #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 22, 2025
Merged

Clarify Documentation for OpenAI-Compatible Base Classes Used by Multiple Providers #95 #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bd4a67
Clarify OpenAI-Compatible Base Class Documentation for Multi-Provider…
raftaar1191 Sep 20, 2025
eb11ada
Clarify docs.
felixarntz Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion ...Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleImageGenerationModel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
6 changes: 5 additions & 1 deletion ...oviders/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleModelMetadataDirectory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
6 changes: 5 additions & 1 deletion src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleTextGenerationModel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
Expand Down
4 changes: 2 additions & 2 deletions ...unit/Providers/OpenAiCompatibleImplementation/MockOpenAiCompatibleTextGenerationModel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Copy link
Member

@felixarntz felixarntz Sep 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great catch!

}

public function exposePrepareMessagesParam(array $messages): array
Expand Down