Custom model names

README.md

@@ -27,6 +27,7 @@ _This library is not developed or endorsed by Google._
   - [Tokens counting](#tokens-counting)
   - [Listing models](#listing-models)
   - [Advanced Usages](#advanced-usages)
+    - [Using Beta version](#using-beta-version)
     - [Safety Settings and Generation Configuration](#safety-settings-and-generation-configuration)
     - [Using your own HTTP client](#using-your-own-http-client)
     - [Using your own HTTP client for streaming responses](#using-your-own-http-client-for-streaming-responses)
@@ -52,10 +53,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 +73,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 +97,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 +136,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 +154,7 @@ $history = [
 ];
 
 $client = new Client('GEMINI_API_KEY');
-$chat = $client->geminiPro()
+$chat = $client->generativeModel(ModelName::GEMINI_PRO)
     ->startChat()
     ->withHistory($history);
 
@@ -179,6 +184,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 +197,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 +215,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 +242,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 +268,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 +289,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'),
 );
 
@@ -322,13 +330,31 @@ print_r($response->models);
 
 ### Advanced Usages
 
+#### Using Beta version
+
+```php
+use GeminiAPI\Client;
+use GeminiAPI\Resources\ModelName;
+use GeminiAPI\Resources\Parts\TextPart;
+
+$client = (new Client('GEMINI_API_KEY'))
+    ->withV1BetaVersion();
+$response = $client->generativeModel(ModelName::GEMINI_PRO)->countTokens(
+    new TextPart('PHP in less than 100 chars'),
+);
+
+print $response->totalTokens;
+// 10
+```
+
 #### Safety Settings and Generation Configuration
 
 ```php
 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 +371,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 +383,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 +392,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 +415,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 +430,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/ChatSession.php

@@ -37,7 +37,7 @@ public function sendMessage(PartInterface ...$parts): GenerateContentResponse
             ->withGenerationConfig($config)
             ->generateContentWithContents($this->history);
 
-        if(!empty($response->candidates)) {
+        if (!empty($response->candidates)) {
             $parts = $response->candidates[0]->content->parts;
             $this->history[] = new Content($parts, Role::Model);
         }
@@ -58,7 +58,7 @@ public function sendMessageStream(
 
         $parts = [];
         $partsCollectorCallback = function (GenerateContentResponse $response) use ($callback, &$parts) {
-            if(!empty($response->candidates)) {
+            if (!empty($response->candidates)) {
                 array_push($parts, ...$response->parts());
             }
 

src/Client.php

@@ -40,6 +40,7 @@
 class Client implements GeminiClientInterface
 {
     private string $baseUrl = 'https://generativelanguage.googleapis.com';
+    private string $version = GeminiClientInterface::API_VERSION_V1;
 
     /**
      * @var array<string, string|string[]>
@@ -87,15 +88,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,
@@ -163,7 +164,7 @@ public function generateContentStream(
             }
         }
 
-        curl_setopt($ch, CURLOPT_URL, "{$this->baseUrl}/v1/{$request->getOperation()}");
+        curl_setopt($ch, CURLOPT_URL, $this->getRequestUrl($request));
         curl_setopt($ch, CURLOPT_POST, true);
         curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($request));
         curl_setopt($ch, CURLOPT_HTTPHEADER, $headerLines);
@@ -214,6 +215,19 @@ public function withBaseUrl(string $baseUrl): self
         return $clone;
     }
 
+    public function withV1BetaVersion(): self
+    {
+        return $this->withVersion(GeminiClientInterface::API_VERSION_V1_BETA);
+    }
+
+    public function withVersion(string $version): self
+    {
+        $clone = clone $this;
+        $clone->version = $version;
+
+        return $clone;
+    }
+
     /**
      * @param array<string, string|string[]> $headers
      * @return self
@@ -241,6 +255,16 @@ private function getRequestHeaders(): array
         ];
     }
 
+    private function getRequestUrl(RequestInterface $request): string
+    {
+        return sprintf(
+            '%s/%s/%s',
+            $this->baseUrl,
+            $this->version,
+            $request->getOperation(),
+        );
+    }
+
     /**
      * @throws ClientExceptionInterface
      */
@@ -250,9 +274,11 @@ private function doRequest(RequestInterface $request): string
             throw new RuntimeException('Missing client or factory for Gemini API operation');
         }
 
-        $uri = "{$this->baseUrl}/v1/{$request->getOperation()}";
         $httpRequest = $this->requestFactory
-            ->createRequest($request->getHttpMethod(), $uri);
+            ->createRequest(
+                $request->getHttpMethod(),
+                $this->getRequestUrl($request),
+            );
 
         foreach ($this->getRequestHeaders() as $name => $value) {
             $httpRequest = $httpRequest->withAddedHeader($name, $value);

src/ClientInterface.php

@@ -21,12 +21,14 @@
 interface ClientInterface
 {
     public const API_KEY_HEADER_NAME = 'x-goog-api-key';
+    public const API_VERSION_V1 = 'v1';
+    public const API_VERSION_V1_BETA = 'v1beta';
 
     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,
     ) {
     }