validateXorFields is modified and model-models xor relation is added, tests are added for chatData parameters (moe-mizrak#6)

* Image content DTOs are added and tests are improved for variety scenarios

* main.yml is moved to workflows directory

* phpunit.xml is removed from gitignore

* Cache Composer Dependencies in main.yml is modified

* bug is resolved: php version in main.yml is fixed

* endpoint for open router api is fixed

* main.yml is fixed for rate limitation on requests

* main.yml is fixed for rate limitation on requests

* tests for response format and stop param are added

* cost reguest is added along with tests and DTO for cost response

* validateXorFields is modified and model-models xor relation is added, tests are added for chatData parameters

Author: moe-mizrak

src/DTO/ChatData.php

@@ -25,18 +25,38 @@ class ChatData extends DataTransferObject
      * @throws \Spatie\DataTransferObject\Exceptions\UnknownProperties
      */
     public function __construct($params)
+    {
+        $this->validateXorFields($params);
+
+        parent::__construct($params);
+    }
+
+    /**
+     * Validate the XOR fields and throw an exception if not valid.
+     *
+     * @param array $params
+     * @throws XorValidationException
+     */
+    private function validateXorFields(array $params): void
     {
         /**
-         * Handle validation for XOR fields here and throw an exception if NOT valid:
+         * Set the fields that have xor relation.
          */
-        $validatorMessagesAndPrompt = new XORFields('messages', 'prompt'); // messages and prompt fields are XOR gated
-        $validationResultMessagesAndPrompt = $validatorMessagesAndPrompt->validate($params); // Validate params
-
-        if (! $validationResultMessagesAndPrompt->isValid) {
-            throw new XorValidationException($validationResultMessagesAndPrompt->message);
+        $xorFields = [
+            ['messages', 'prompt'], // messages and prompt fields are XOR gated
+            ['model', 'models'], // model and models fields are XOR gated
+        ];
+
+        // Loop through the xor fields and validate
+        foreach ($xorFields as [$firstField, $secondField]) {
+            $validator = new XORFields($firstField, $secondField);
+            $validationResult = $validator->validate($params);
+
+            // Throw exception in case validation is failed.
+            if (!$validationResult->isValid) {
+                throw new XorValidationException($validationResult->message);
+            }
         }
-
-        parent::__construct($params);
     }
 
     /**
@@ -100,10 +120,10 @@ public function __construct($params)
     /**
      * Only natively supported by OpenAI models. For others, we submit a YAML-formatted string with these tools at the end of the prompt.
      *
-     * @var string|ToolCallData|null
+     * @var string|array|null
      */
     #[AllowedValues([ToolChoiceType::AUTO, ToolChoiceType::NONE])]
-    public string|ToolCallData|null $tool_choice; // none|auto or ToolCallData as {"type": "function", "function": {"name": "my_function"}}
+    public string|array|null $tool_choice; // none|auto or ToolCallData as {"type": "function", "function": {"name": "my_function"}}
 
     /**
      * Tool calls (also known as function calling) allow you to give an LLM access to external tools.
@@ -116,7 +136,7 @@ public function __construct($params)
     /**
      * Modify the likelihood of specified tokens appearing in the completion. e.g. {"50256": -100}
      */
-    public ?array $logit_bias; // todo json object, map => check openai doc and test it for array also
+    public ?array $logit_bias;
 
     // OpenRouter-only parameters
     /**

src/DTO/ToolCallData.php

@@ -23,9 +23,9 @@ class ToolCallData extends DataTransferObject
     /**
      * Name of the tool. (i.e. function)
      *
-     * @var string
+     * @var string|null
      */
-    public string $type;
+    public ?string $type;
 
     /**
      * Function DTO object.

src/Rules/AllowedValues.php

@@ -2,7 +2,6 @@
 
 namespace MoeMizrak\LaravelOpenrouter\Rules;
 
-use Spatie\DataTransferObject\DataTransferObject;
 use Spatie\DataTransferObject\Validation\ValidationResult;
 use Spatie\DataTransferObject\Validator;
 
@@ -29,7 +28,7 @@ public function __construct(protected array $acceptableValues = [])
      */
     public function validate(mixed $value): ValidationResult
     {
-        if (in_array($value, $this->acceptableValues) || is_null($value) || $value instanceof DataTransferObject) {
+        if (in_array($value, $this->acceptableValues) || is_null($value) || is_array($value)) {
             return ValidationResult::valid();
         }