Add parameters to vector store list functions

openai-php · Jun 6, 2024 · 667134c · 667134c
1 parent ebbc0e6
commit 667134c
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 24 deletions.
diff --git a/src/Contracts/Resources/VectorStoresContract.php b/src/Contracts/Resources/VectorStoresContract.php
@@ -21,15 +21,17 @@ public function create(array $parameters): VectorStoreResponse;
      * Returns a list of vector stores.
      *
      * @see https://platform.openai.com/docs/api-reference/vector-stores/list
+     *
+     * @param  array<string, mixed>  $parameters
      */
-    public function list(): VectorStoreListResponse;
+    public function list(array $parameters = []): VectorStoreListResponse;
 
     /**
      * Retrieves a vector store.
      *
      * @see https://platform.openai.com/docs/api-reference/vector-stores/retrieve
      */
-    public function retrieve(string $vectorStore): VectorStoreResponse;
+    public function retrieve(string $vectorStoreId): VectorStoreResponse;
 
     /**
      * Modify a vector store
@@ -38,14 +40,14 @@ public function retrieve(string $vectorStore): VectorStoreResponse;
      *
      * @param  array<string, mixed>  $parameters
      */
-    public function modify(string $vectorStore, array $parameters): VectorStoreResponse;
+    public function modify(string $vectorStoreId, array $parameters): VectorStoreResponse;
 
     /**
      * Delete a vector store.
      *
      * https://platform.openai.com/docs/api-reference/vector-stores/delete
      */
-    public function delete(string $vectorStore): VectorStoreDeleteResponse;
+    public function delete(string $vectorStoreId): VectorStoreDeleteResponse;
 
     /**
      * Manage the files related to the vector store

diff --git a/src/Contracts/Resources/VectorStoresFileBatchesContract.php b/src/Contracts/Resources/VectorStoresFileBatchesContract.php
@@ -34,6 +34,8 @@ public function cancel(string $vectorStoreId, string $fileBatchId): VectorStoreF
      * Lists the files within a file batch within a vector store
      *
      * @see https://platform.openai.com/docs/api-reference/vector-stores-file-batches/listBatchFiles
+     *
+     * @param  array<string, mixed>  $parameters
      */
-    public function listFiles(string $vectorStoreId, string $fileBatchId): VectorStoreFileListResponse;
+    public function listFiles(string $vectorStoreId, string $fileBatchId, array $parameters = []): VectorStoreFileListResponse;
 }
diff --git a/src/Contracts/Resources/VectorStoresFilesContract.php b/src/Contracts/Resources/VectorStoresFilesContract.php
@@ -21,8 +21,10 @@ public function create(string $vectorStoreId, array $parameters): VectorStoreFil
      * Returns a list of files within a vector store.
      *
      * @see https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles
+     *
+     * @param  array<string, mixed>  $parameters
      */
-    public function list(string $vectorStoreId): VectorStoreFileListResponse;
+    public function list(string $vectorStoreId, array $parameters = []): VectorStoreFileListResponse;
 
     /**
      * Retrieves a file within a vector store.

diff --git a/src/Resources/VectorStores.php b/src/Resources/VectorStores.php
@@ -38,10 +38,12 @@ public function create(array $parameters): VectorStoreResponse
      * Returns a list of vector stores.
      *
      * @see https://platform.openai.com/docs/api-reference/vector-stores/list
+     *
+     * @param  array<string, mixed>  $parameters
      */
-    public function list(): VectorStoreListResponse
+    public function list(array $parameters = []): VectorStoreListResponse
     {
-        $payload = Payload::list('vector_stores');
+        $payload = Payload::list('vector_stores', $parameters);
 
         /** @var Response<array{object: string, data: array<int, array{id: string, object: string, created_at: int, name: ?string, usage_bytes: int, file_counts: array{in_progress: int, completed: int, failed: int, cancelled: int, total: int}, status: string, expires_after: ?array{anchor: string, days: int}, expires_at: ?int, last_active_at: ?int, metadata: array<string, string>}>, first_id: ?string, last_id: ?string, has_more: bool}> $response */
         $response = $this->transporter->requestObject($payload);
@@ -54,9 +56,9 @@ public function list(): VectorStoreListResponse
      *
      * @see https://platform.openai.com/docs/api-reference/vector-stores/retrieve
      */
-    public function retrieve(string $vectorStore): VectorStoreResponse
+    public function retrieve(string $vectorStoreId): VectorStoreResponse
     {
-        $payload = Payload::retrieve('vector_stores', $vectorStore);
+        $payload = Payload::retrieve('vector_stores', $vectorStoreId);
 
         /** @var Response<array{id: string, object: string, created_at: int, name: ?string, usage_bytes: int, file_counts: array{in_progress: int, completed: int, failed: int, cancelled: int, total: int}, status: string, expires_after: ?array{anchor: string, days: int}, expires_at: ?int, last_active_at: ?int, metadata: array<string, string>}> $response */
         $response = $this->transporter->requestObject($payload);
@@ -71,9 +73,9 @@ public function retrieve(string $vectorStore): VectorStoreResponse
      *
      * @param  array<string, mixed>  $parameters
      */
-    public function modify(string $vectorStore, array $parameters): VectorStoreResponse
+    public function modify(string $vectorStoreId, array $parameters): VectorStoreResponse
     {
-        $payload = Payload::modify('vector_stores', $vectorStore, $parameters);
+        $payload = Payload::modify('vector_stores', $vectorStoreId, $parameters);
 
         /** @var Response<array{id: string, object: string, created_at: int, name: ?string, usage_bytes: int, file_counts: array{in_progress: int, completed: int, failed: int, cancelled: int, total: int}, status: string, expires_after: ?array{anchor: string, days: int}, expires_at: ?int, last_active_at: ?int, metadata: array<string, string>}> $response */
         $response = $this->transporter->requestObject($payload);
@@ -86,9 +88,9 @@ public function modify(string $vectorStore, array $parameters): VectorStoreRespo
      *
      * https://platform.openai.com/docs/api-reference/vector-stores/delete
      */
-    public function delete(string $vectorStore): VectorStoreDeleteResponse
+    public function delete(string $vectorStoreId): VectorStoreDeleteResponse
     {
-        $payload = Payload::delete('vector_stores', $vectorStore);
+        $payload = Payload::delete('vector_stores', $vectorStoreId);
 
         /** @var Response<array{id: string, object: string, deleted: bool}> $response */
         $response = $this->transporter->requestObject($payload);

diff --git a/src/Resources/VectorStoresFileBatches.php b/src/Resources/VectorStoresFileBatches.php
@@ -50,10 +50,12 @@ public function retrieve(string $vectorStoreId, string $fileBatchId): VectorStor
      * Lists the files within a file batch within a vector store
      *
      * @see https://platform.openai.com/docs/api-reference/vector-stores-file-batches/listBatchFiles
+     *
+     * @param  array<string, mixed>  $parameters
      */
-    public function listFiles(string $vectorStoreId, string $fileBatchId): VectorStoreFileListResponse
+    public function listFiles(string $vectorStoreId, string $fileBatchId, array $parameters = []): VectorStoreFileListResponse
     {
-        $payload = Payload::list("vector_stores/$vectorStoreId/file_batches/$fileBatchId/files");
+        $payload = Payload::list("vector_stores/$vectorStoreId/file_batches/$fileBatchId/files", $parameters);
 
         /** @var Response<array{object: string, data: array<int, array{id: string, object: string, usage_bytes: int, created_at: int, vector_store_id: string, status: string, last_error: ?array{code: string, message: string}, chunking_strategy: array{type: 'static', static: array{max_chunk_size_tokens: int, chunk_overlap_tokens: int}}|array{type: 'other'}}>, first_id: ?string, last_id: ?string, has_more: bool}> $response */
         $response = $this->transporter->requestObject($payload);

diff --git a/src/Resources/VectorStoresFiles.php b/src/Resources/VectorStoresFiles.php
@@ -36,10 +36,12 @@ public function create(string $vectorStoreId, array $parameters): VectorStoreFil
      * Returns a list of files within a vector store.
      *
      * @see https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles
+     *
+     * @param  array<string, mixed>  $parameters
      */
-    public function list(string $vectorStoreId): VectorStoreFileListResponse
+    public function list(string $vectorStoreId, array $parameters = []): VectorStoreFileListResponse
     {
-        $payload = Payload::list("vector_stores/$vectorStoreId/files");
+        $payload = Payload::list("vector_stores/$vectorStoreId/files", $parameters);
 
         /** @var Response<array{object: string, data: array<int, array{id: string, object: string, usage_bytes: int, created_at: int, vector_store_id: string, status: string, last_error: ?array{code: string, message: string}, chunking_strategy: array{type: 'static', static: array{max_chunk_size_tokens: int, chunk_overlap_tokens: int}}|array{type: 'other'}}>, first_id: ?string, last_id: ?string, has_more: bool}> $response */
         $response = $this->transporter->requestObject($payload);

diff --git a/src/Testing/Resources/VectorStoresFileBatchesTestResource.php b/src/Testing/Resources/VectorStoresFileBatchesTestResource.php
@@ -32,7 +32,7 @@ public function create(string $vectorStoreId, array $parameters): VectorStoreFil
         return $this->record(__FUNCTION__, func_get_args());
     }
 
-    public function listFiles(string $vectorStoreId, string $fileBatchId): VectorStoreFileListResponse
+    public function listFiles(string $vectorStoreId, string $fileBatchId, array $parameters = []): VectorStoreFileListResponse
     {
         return $this->record(__FUNCTION__, func_get_args());
     }

diff --git a/src/Testing/Resources/VectorStoresFilesTestResource.php b/src/Testing/Resources/VectorStoresFilesTestResource.php
@@ -33,7 +33,7 @@ public function create(string $vectorStoreId, array $parameters): VectorStoreFil
         return $this->record(__FUNCTION__, func_get_args());
     }
 
-    public function list(string $vectorStoreId): VectorStoreFileListResponse
+    public function list(string $vectorStoreId, array $parameters = []): VectorStoreFileListResponse
     {
         return $this->record(__FUNCTION__, func_get_args());
     }

diff --git a/src/Testing/Resources/VectorStoresTestResource.php b/src/Testing/Resources/VectorStoresTestResource.php
@@ -20,17 +20,17 @@ public function resource(): string
         return VectorStores::class;
     }
 
-    public function modify(string $vectorStore, array $parameters): VectorStoreResponse
+    public function modify(string $vectorStoreId, array $parameters): VectorStoreResponse
     {
         return $this->record(__FUNCTION__, func_get_args());
     }
 
-    public function retrieve(string $vectorStore): VectorStoreResponse
+    public function retrieve(string $vectorStoreId): VectorStoreResponse
     {
         return $this->record(__FUNCTION__, func_get_args());
     }
 
-    public function delete(string $vectorStore): VectorStoreDeleteResponse
+    public function delete(string $vectorStoreId): VectorStoreDeleteResponse
     {
         return $this->record(__FUNCTION__, func_get_args());
     }
@@ -40,7 +40,7 @@ public function create(array $parameters): VectorStoreResponse
         return $this->record(__FUNCTION__, func_get_args());
     }
 
-    public function list(): VectorStoreListResponse
+    public function list(array $parameters = []): VectorStoreListResponse
     {
         return $this->record(__FUNCTION__, func_get_args());
     }