AbstractOpenAiCompatibleTextGenerationModel

Description

Methods · 17

• generateTextResult(){@inheritDoc}
• prepareGenerateTextParams()Prepares the given prompt and the model configuration into parameters for the API request.
• prepareMessagesParam()Prepares the messages parameter for the API request.
• getMessageRoleString()Returns the OpenAI API specific role string for the given message role.
• getMessagePartContentData()Returns the OpenAI API specific content data for a message part.
• getMessagePartToolCallData()Returns the OpenAI API specific tool calls data for a message part.
• validateOutputModalities()Validates that the given output modalities to ensure that at least one output modality is text.
• prepareOutputModalitiesParam()Prepares the output modalities parameter for the API request.
• prepareToolsParam()Prepares the tools parameter for the API request.
• prepareResponseFormatParam()Prepares the response format parameter for the API request.
• createRequest()Creates a request object for the provider's API.
• throwIfNotSuccessful()Throws an exception if the response is not successful.
• parseResponseToGenerativeAiResult()Parses the response from the API endpoint to a generative AI result.
• parseResponseChoiceToCandidate()Parses a single choice from the API response into a Candidate object.
• parseResponseChoiceMessage()Parses the message from a choice in the API response.
• parseResponseChoiceMessageParts()Parses the message parts from a choice in the API response.
• parseResponseChoiceMessageToolCallPart()Parses a tool call part from the API response.

Source

View on Trac ↗View on GitHub ↗

64abstract class AbstractOpenAiCompatibleTextGenerationModel extends AbstractApiBasedModel implements TextGenerationModelInterface65{66    /**67     * {@inheritDoc}68     *69     * @since 0.1.070     */71    final public function generateTextResult(array $prompt): GenerativeAiResult72    {73        $httpTransporter = $this->getHttpTransporter();74        $params = $this->prepareGenerateTextParams($prompt);75        $request = $this->createRequest(HttpMethodEnum::POST(), 'chat/completions', ['Content-Type' => 'application/json'], $params);76        // Add authentication credentials to the request.77        $request = $this->getRequestAuthentication()->authenticateRequest($request);78        // Send and process the request.79        $response = $httpTransporter->send($request);80        $this->throwIfNotSuccessful($response);81        return $this->parseResponseToGenerativeAiResult($response);82    }83    /**84     * Prepares the given prompt and the model configuration into parameters for the API request.85     *86     * @since 0.1.087     *88     * @param list<Message> $prompt The prompt to generate text for. Either a single message or a list of messages89     *                              from a chat.90     * @return array<string, mixed> The parameters for the API request.91     */92    protected function prepareGenerateTextParams(array $prompt): array93    {94        $config = $this->getConfig();95        $params = ['model' => $this->metadata()->getId(), 'messages' => $this->prepareMessagesParam($prompt, $config->getSystemInstruction())];96        $outputModalities = $config->getOutputModalities();97        if (is_array($outputModalities)) {98            $this->validateOutputModalities($outputModalities);99            if (count($outputModalities) > 1) {100                $params['modalities'] = $this->prepareOutputModalitiesParam($outputModalities);101            }102        }103        $candidateCount = $config->getCandidateCount();104        if ($candidateCount !== null) {105            $params['n'] = $candidateCount;106        }107        $maxTokens = $config->getMaxTokens();108        if ($maxTokens !== null) {109            $params['max_tokens'] = $maxTokens;110        }111        $temperature = $config->getTemperature();112        if ($temperature !== null) {113            $params['temperature'] = $temperature;114        }115        $topP = $config->getTopP();116        if ($topP !== null) {117            $params['top_p'] = $topP;118        }119        $stopSequences = $config->getStopSequences();120        if (is_array($stopSequences)) {121            $params['stop'] = $stopSequences;122        }123        $presencePenalty = $config->getPresencePenalty();124        if ($presencePenalty !== null) {125            $params['presence_penalty'] = $presencePenalty;126        }127        $frequencyPenalty = $config->getFrequencyPenalty();128        if ($frequencyPenalty !== null) {129            $params['frequency_penalty'] = $frequencyPenalty;130        }131        $logprobs = $config->getLogprobs();132        if ($logprobs !== null) {133            $params['logprobs'] = $logprobs;134        }135        $topLogprobs = $config->getTopLogprobs();136        if ($topLogprobs !== null) {137            $params['top_logprobs'] = $topLogprobs;138        }139        $functionDeclarations = $config->getFunctionDeclarations();140        if (is_array($functionDeclarations)) {141            $params['tools'] = $this->prepareToolsParam($functionDeclarations);142        }143        $outputMimeType = $config->getOutputMimeType();

History

Introduced in 0.1.0. Unchanged from 7.0.4 through 7.1.0.

1. 7.0.4
2. 7.1.0

Signature, return type and hooks compared across 2 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/php-ai-client/src/Providers/OpenAiCompatibleImplementation/AbstractOpenAiCompatibleTextGenerationModel.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.