Merge pull request #22 from xp-forge/feature/realtime-parameters

Allow specifying parameters in the RealtimeApi constructor

Author: thekid

README.md

@@ -344,10 +344,10 @@ For Azure AI, the setup code is slightly different:
 use com\openai\realtime\RealtimeApi;
 use util\cmd\Console;
 
-$api= new RealtimeApi('wss://example.openai.azure.com/openai/realtime?'.
-  '?api-version=2024-10-01-preview'.
-  '&deployment=gpt-4o-realtime-preview'
-);
+$api= new RealtimeApi('wss://example.openai.azure.com/openai/realtime', [
+  'api-version' => '2024-10-01-preview',
+  'deployment'  => 'gpt-4o-realtime-preview',
+]);
 $session= $api->connect(['api-key' => getenv('AZUREAI_API_KEY')]);
 ```
 

src/main/php/com/openai/realtime/RealtimeApi.class.php

@@ -22,9 +22,25 @@ class RealtimeApi implements Traceable, Value {
   private $ws, $marshalling;
   private $cat= null;
 
-  /** @param string|util.URI|websocket.WebSocket $endpoint */
-  public function __construct($endpoint) {
-    $this->ws= $endpoint instanceof WebSocket ? $endpoint : new WebSocket((string)$endpoint);
+  /**
+   * Creates a new realtime API instance
+   *
+   * @param  string|util.URI|websocket.WebSocket $endpoint
+   * @param  [:string] $parameters
+   */
+  public function __construct($endpoint, array $parameters= []) {
+    if ($endpoint instanceof WebSocket) {
+      $this->ws= $endpoint;
+    } else if ($parameters) {
+      $uri= $endpoint instanceof URI ? $endpoint->using() : (new URI($endpoint))->using();
+      foreach ($parameters as $name => $value) {
+        $uri->param($name, $value);
+      }
+      $this->ws= new WebSocket($uri->create());
+    } else {
+      $this->ws= new WebSocket($endpoint);
+    }
+
     $this->marshalling= (new Marshalling())->mapping(Tools::class, function($tools) {
       foreach ($tools->selection as $select) {
         if ($select instanceof Functions) {
@@ -43,6 +59,9 @@ public function __construct($endpoint) {
     });
   }
 
+  /** @return string */
+  public function path() { return $this->ws->path(); }
+
   /** @return peer.Socket */
   public function socket() { return $this->ws->socket(); }
 

src/test/php/com/openai/unittest/RealtimeApiTest.class.php

@@ -32,6 +32,38 @@ public function socket_accessor() {
     Assert::instance(Socket::class, (new RealtimeApi(self::URI))->socket());
   }
 
+  #[Test]
+  public function path_accessor() {
+    Assert::equals(
+      '/v1/realtime?model=gpt-4o-realtime-preview-2024-10-01',
+      (new RealtimeApi(self::URI))->path()
+    );
+  }
+
+  #[Test]
+  public function base_and_parameters() {
+    Assert::equals(
+      '/v1/realtime?model=gpt-realtime-2026',
+      (new RealtimeApi('wss://api.openai.com/v1/realtime', ['model' => 'gpt-realtime-2026']))->path()
+    );
+  }
+
+  #[Test]
+  public function addding_parameters() {
+    Assert::equals(
+      '/v1/realtime?model=gpt-4o-realtime-preview-2024-10-01&api-version=2024-10-01-preview',
+      (new RealtimeApi(self::URI, ['api-version' => '2024-10-01-preview']))->path()
+    );
+  }
+
+  #[Test]
+  public function overwriting_parameters() {
+    Assert::equals(
+      '/v1/realtime?model=gpt-realtime-2026',
+      (new RealtimeApi(self::URI, ['model' => 'gpt-realtime-2026']))->path()
+    );
+  }
+
   #[Test]
   public function connect() {
     $c= new RealtimeApi(new TestingSocket([self::SESSION_CREATED]));