client-34 Allowing new/custom model names

Closes #34

Author: erdemkose

README.md

@@ -52,10 +52,11 @@ you need to allow `php-http/discovery` composer plugin or install a PSR-18 compa
 
 ```php
 use GeminiAPI\Client;
+use GeminiAPI\Resources\ModelName;
 use GeminiAPI\Resources\Parts\TextPart;
 
 $client = new Client('GEMINI_API_KEY');
-$response = $client->geminiPro()->generateContent(
+$response = $client->generativeModel(ModelName::GEMINI_PRO)->generateContent(
     new TextPart('PHP in less than 100 chars'),
 );
 
@@ -71,11 +72,12 @@ print $response->text();
 ```php
 use GeminiAPI\Client;
 use GeminiAPI\Enums\MimeType;
+use GeminiAPI\Resources\ModelName;
 use GeminiAPI\Resources\Parts\ImagePart;
 use GeminiAPI\Resources\Parts\TextPart;
 
 $client = new Client('GEMINI_API_KEY');
-$response = $client->geminiProVision()->generateContent(
+$response = $client->generativeModel(ModelName::GEMINI_PRO)->generateContent(
     new TextPart('Explain what is in the image'),
     new ImagePart(
         MimeType::IMAGE_JPEG,
@@ -94,10 +96,11 @@ print $response->text();
 
 ```php
 use GeminiAPI\Client;
+use GeminiAPI\Resources\ModelName;
 use GeminiAPI\Resources\Parts\TextPart;
 
 $client = new Client('GEMINI_API_KEY');
-$chat = $client->geminiPro()->startChat();
+$chat = $client->generativeModel(ModelName::GEMINI_PRO)->startChat();
 
 $response = $chat->sendMessage(new TextPart('Hello World in PHP'));
 print $response->text();
@@ -132,6 +135,7 @@ This code will print "Hello World!" to the standard output.
 use GeminiAPI\Client;
 use GeminiAPI\Enums\Role;
 use GeminiAPI\Resources\Content;
+use GeminiAPI\Resources\ModelName;
 use GeminiAPI\Resources\Parts\TextPart;
 
 $history = [
@@ -149,7 +153,7 @@ $history = [
 ];
 
 $client = new Client('GEMINI_API_KEY');
-$chat = $client->geminiPro()
+$chat = $client->generativeModel(ModelName::GEMINI_PRO)
     ->startChat()
     ->withHistory($history);
 
@@ -179,6 +183,7 @@ Long responses may be broken into separate responses, and you can start receivin
 
 ```php
 use GeminiAPI\Client;
+use GeminiAPI\Resources\ModelName;
 use GeminiAPI\Resources\Parts\TextPart;
 use GeminiAPI\Responses\GenerateContentResponse;
 
@@ -191,7 +196,7 @@ $callback = function (GenerateContentResponse $response): void {
 };
 
 $client = new Client('GEMINI_API_KEY');
-$client->geminiPro()->generateContentStream(
+$client->generativeModel(ModelName::GEMINI_PRO)->generateContentStream(
     $callback,
     [new TextPart('PHP in less than 100 chars')],
 );
@@ -209,6 +214,7 @@ $client->geminiPro()->generateContentStream(
 use GeminiAPI\Client;
 use GeminiAPI\Enums\Role;
 use GeminiAPI\Resources\Content;
+use GeminiAPI\Resources\ModelName;
 use GeminiAPI\Resources\Parts\TextPart;
 use GeminiAPI\Responses\GenerateContentResponse;
 
@@ -235,7 +241,7 @@ $callback = function (GenerateContentResponse $response): void {
 };
 
 $client = new Client('GEMINI_API_KEY');
-$chat = $client->geminiPro()
+$chat = $client->generativeModel(ModelName::GEMINI_PRO)
     ->startChat()
     ->withHistory($history);
 
@@ -261,11 +267,11 @@ This code will print "Hello World!" to the standard output.
 
 ```php
 use GeminiAPI\Client;
-use GeminiAPI\Enums\ModelName;
+use GeminiAPI\Resources\ModelName;
 use GeminiAPI\Resources\Parts\TextPart;
 
 $client = new Client('GEMINI_API_KEY');
-$response = $client->embeddingModel(ModelName::Embedding)
+$response = $client->embeddingModel(ModelName::EMBEDDING_001)
     ->embedContent(
         new TextPart('PHP in less than 100 chars'),
     );
@@ -282,10 +288,11 @@ print_r($response->embedding->values);
 
 ```php
 use GeminiAPI\Client;
+use GeminiAPI\Resources\ModelName;
 use GeminiAPI\Resources\Parts\TextPart;
 
 $client = new Client('GEMINI_API_KEY');
-$response = $client->geminiPro()->countTokens(
+$response = $client->generativeModel(ModelName::GEMINI_PRO)->countTokens(
     new TextPart('PHP in less than 100 chars'),
 );
 
@@ -329,6 +336,7 @@ use GeminiAPI\Client;
 use GeminiAPI\Enums\HarmCategory;
 use GeminiAPI\Enums\HarmBlockThreshold;
 use GeminiAPI\GenerationConfig;
+use GeminiAPI\Resources\ModelName;
 use GeminiAPI\Resources\Parts\TextPart;
 use GeminiAPI\SafetySetting;
 
@@ -345,7 +353,7 @@ $generationConfig = (new GenerationConfig())
     ->withStopSequences(['STOP']);
 
 $client = new Client('GEMINI_API_KEY');
-$response = $client->geminiPro()
+$response = $client->generativeModel(ModelName::GEMINI_PRO)
     ->withAddedSafetySetting($safetySetting)
     ->withGenerationConfig($generationConfig)
     ->generateContent(
@@ -357,6 +365,7 @@ $response = $client->geminiPro()
 
 ```php
 use GeminiAPI\Client as GeminiClient;
+use GeminiAPI\Resources\ModelName;
 use GeminiAPI\Resources\Parts\TextPart;
 use GuzzleHttp\Client as GuzzleClient;
 
@@ -365,7 +374,7 @@ $guzzle = new GuzzleClient([
 ]);
 
 $client = new GeminiClient('GEMINI_API_KEY', $guzzle);
-$response = $client->geminiPro()->generateContent(
+$response = $client->generativeModel(ModelName::GEMINI_PRO)->generateContent(
     new TextPart('PHP in less than 100 chars')
 );
 ```
@@ -388,6 +397,7 @@ You can also pass the headers you want to be used in the requests.
 
 ```php
 use GeminiAPI\Client;
+use GeminiAPI\Resources\ModelName;
 use GeminiAPI\Resources\Parts\TextPart;
 use GeminiAPI\Responses\GenerateContentResponse;
 
@@ -402,7 +412,7 @@ $client = new Client('GEMINI_API_KEY');
 $client->withRequestHeaders([
         'User-Agent' => 'My Gemini-backed app'
     ])
-    ->geminiPro()
+    ->generativeModel(ModelName::GEMINI_PRO)
     ->generateContentStream(
         $callback,
         [new TextPart('PHP in less than 100 chars')],

src/Client.php

@@ -87,15 +87,15 @@ public function geminiProFlash1_5(): GenerativeModel
     }
 
 
-    public function generativeModel(ModelName $modelName): GenerativeModel
+    public function generativeModel(ModelName|string $modelName): GenerativeModel
     {
         return new GenerativeModel(
             $this,
             $modelName,
         );
     }
 
-    public function embeddingModel(ModelName $modelName): EmbeddingModel
+    public function embeddingModel(ModelName|string $modelName): EmbeddingModel
     {
         return new EmbeddingModel(
             $this,

src/ClientInterface.php

@@ -25,8 +25,8 @@ interface ClientInterface
     public function countTokens(CountTokensRequest $request): CountTokensResponse;
     public function generateContent(GenerateContentRequest $request): GenerateContentResponse;
     public function embedContent(EmbedContentRequest $request): EmbedContentResponse;
-    public function generativeModel(ModelName $modelName): GenerativeModel;
-    public function embeddingModel(ModelName $modelName): EmbeddingModel;
+    public function generativeModel(ModelName|string $modelName): GenerativeModel;
+    public function embeddingModel(ModelName|string $modelName): EmbeddingModel;
     public function listModels(): ListModelsResponse;
     public function withBaseUrl(string $baseUrl): self;
 

src/EmbeddingModel.php

@@ -19,7 +19,7 @@ class EmbeddingModel
 
     public function __construct(
         private readonly Client $client,
-        public readonly ModelName $modelName,
+        public readonly ModelName|string $modelName,
     ) {
     }
 

src/Enums/ModelName.php

@@ -4,6 +4,9 @@
 
 namespace GeminiAPI\Enums;
 
+/**
+ * @deprecated Use constants from GeminiAPI\Resources\ModelName instead
+ */
 enum ModelName: string
 {
     case Default = 'models/text-bison-001';

src/GenerativeModel.php

@@ -4,7 +4,6 @@
 
 namespace GeminiAPI;
 
-use BadMethodCallException;
 use CurlHandle;
 use GeminiAPI\Enums\ModelName;
 use GeminiAPI\Enums\Role;
@@ -29,7 +28,7 @@ class GenerativeModel
 
     public function __construct(
         private readonly Client $client,
-        public readonly ModelName $modelName,
+        public readonly ModelName|string $modelName,
     ) {
     }
 

src/Requests/CountTokensRequest.php

@@ -5,30 +5,32 @@
 namespace GeminiAPI\Requests;
 
 use GeminiAPI\Enums\ModelName;
-use GeminiAPI\Traits\ArrayTypeValidator;
 use GeminiAPI\Resources\Content;
+use GeminiAPI\Traits\ArrayTypeValidator;
+use GeminiAPI\Traits\ModelNameToString;
 use JsonSerializable;
 
 use function json_encode;
 
 class CountTokensRequest implements JsonSerializable, RequestInterface
 {
     use ArrayTypeValidator;
+    use ModelNameToString;
 
     /**
-     * @param ModelName $modelName
+     * @param ModelName|string $modelName
      * @param Content[] $contents
      */
     public function __construct(
-        public readonly ModelName $modelName,
+        public readonly ModelName|string $modelName,
         public readonly array $contents,
     ) {
         $this->ensureArrayOfType($this->contents, Content::class);
     }
 
     public function getOperation(): string
     {
-        return "{$this->modelName->value}:countTokens";
+        return "{$this->modelNameToString($this->modelName)}:countTokens";
     }
 
     public function getHttpMethod(): string
@@ -50,7 +52,7 @@ public function getHttpPayload(): string
     public function jsonSerialize(): array
     {
         return [
-            'model' => $this->modelName->value,
+            'model' => $this->modelNameToString($this->modelName),
             'contents' => $this->contents,
         ];
     }

src/Requests/EmbedContentRequest.php

@@ -8,30 +8,29 @@
 use GeminiAPI\Enums\ModelName;
 use GeminiAPI\Enums\TaskType;
 use GeminiAPI\Resources\Content;
+use GeminiAPI\Traits\ModelNameToString;
 use JsonSerializable;
 
 use function json_encode;
 
 class EmbedContentRequest implements JsonSerializable, RequestInterface
 {
+    use ModelNameToString;
+
     public function __construct(
-        public readonly ModelName $modelName,
+        public readonly ModelName|string $modelName,
         public readonly Content $content,
         public readonly ?TaskType $taskType = null,
         public readonly ?string $title = null,
     ) {
-        if (isset($this->taskType) && $this->modelName !== ModelName::Embedding) {
-            throw new BadMethodCallException('TaskType can only be set when ModelName is Embedding');
-        }
-
         if (isset($this->title) && $this->taskType !== TaskType::RETRIEVAL_DOCUMENT) {
             throw new BadMethodCallException('Title is only applicable when TaskType is RETRIEVAL_DOCUMENT');
         }
     }
 
     public function getOperation(): string
     {
-        return "{$this->modelName->value}:embedContent";
+        return "{$this->modelNameToString($this->modelName)}:embedContent";
     }
 
     public function getHttpMethod(): string

src/Requests/GenerateContentRequest.php

@@ -6,25 +6,27 @@
 
 use GeminiAPI\Enums\ModelName;
 use GeminiAPI\GenerationConfig;
+use GeminiAPI\Resources\Content;
 use GeminiAPI\SafetySetting;
 use GeminiAPI\Traits\ArrayTypeValidator;
-use GeminiAPI\Resources\Content;
+use GeminiAPI\Traits\ModelNameToString;
 use JsonSerializable;
 
 use function json_encode;
 
 class GenerateContentRequest implements JsonSerializable, RequestInterface
 {
     use ArrayTypeValidator;
+    use ModelNameToString;
 
     /**
-     * @param ModelName $modelName
+     * @param ModelName|string $modelName
      * @param Content[] $contents
      * @param SafetySetting[] $safetySettings
      * @param GenerationConfig|null $generationConfig
      */
     public function __construct(
-        public readonly ModelName $modelName,
+        public readonly ModelName|string $modelName,
         public readonly array $contents,
         public readonly array $safetySettings = [],
         public readonly ?GenerationConfig $generationConfig = null,
@@ -35,7 +37,7 @@ public function __construct(
 
     public function getOperation(): string
     {
-        return "{$this->modelName->value}:generateContent";
+        return "{$this->modelNameToString($this->modelName)}:generateContent";
     }
 
     public function getHttpMethod(): string
@@ -59,7 +61,7 @@ public function getHttpPayload(): string
     public function jsonSerialize(): array
     {
         $arr = [
-            'model' => $this->modelName->value,
+            'model' => $this->modelNameToString($this->modelName),
             'contents' => $this->contents,
         ];