feat: enhance API functionality with new endpoints and request structures

- Added methods for tenant management: create, update, and retrieve tenants.
- Introduced new endpoints for collection management: create, update, delete, and query collections.
- Updated existing methods to improve clarity and functionality, including health checks and user identity retrieval.
- Enhanced request classes with detailed parameter documentation for better usability.
- Refactored existing methods to align with new naming conventions for consistency.

Author: CodeWithKyrian

src/Api.php

@@ -10,35 +10,18 @@
  */
 class AddEmbeddingRequest
 {
+    /**
+     * @param float[][] $embeddings Optional embeddings of the items to add.
+     * @param array<array<string, string>> $metadatas Optional metadatas of the items to add.
+     * @param string[] $ids IDs of the items to add.
+     * @param string[] $documents Optional documents of the items to add.
+     * @param string[] $images Optional images of the items to add.
+     */
     public function __construct(
-        /**
-         * Optional embeddings of the items to add.
-         *
-         * @var float[][]
-         */
         public readonly ?array $embeddings,
-
-        /**
-         * Optional metadatas of the items to add.
-         *
-         * @var array<array<string, string>>
-         */
         public readonly ?array $metadatas,
-
-        /**
-         * IDs of the items to add.
-         *
-         * @var string[]
-         */
         public readonly array $ids,
-
-        /**
-         * Optional documents of the items to add.
-         *
-         * @var string[]
-         */
         public readonly ?array $documents,
-
         public readonly ?array $images,
 
     ) {}

src/Requests/AddEmbeddingRequest.php

@@ -10,22 +10,14 @@
  */
 class CreateCollectionRequest
 {
+    /**
+     * @param string $name The name of the collection
+     * @param array<string, string> $metadata The metadata of the collection
+     * @param bool $getOrCreate If true, will return existing collection if it exists, otherwise will throw an exception.
+     */
     public function __construct(
-        /**
-         * The name of the collection
-         */
         public readonly string $name,
-
-        /**
-         * The metadata of the collection
-         *
-         * @var array<string, string>
-         */
         public readonly ?array $metadata,
-
-        /**
-         * If true, will return existing collection if it exists.
-         */
         public readonly bool $getOrCreate = false,
     ) {}
 

src/Requests/CreateCollectionRequest.php

@@ -7,6 +7,9 @@
 
 class CreateDatabaseRequest
 {
+    /**
+     * @param string $name The name of the database
+     */
     public function __construct(
         public readonly string $name,
     ) {}

src/Requests/CreateDatabaseRequest.php

@@ -7,6 +7,9 @@
 
 class CreateTenantRequest
 {
+    /**
+     * @param string $name The name of the tenant
+     */
     public function __construct(
         public readonly string $name,
     ) {}

src/Requests/CreateTenantRequest.php

@@ -7,26 +7,14 @@
 
 class DeleteEmbeddingRequest
 {
+    /**
+     * @param string[] $ids Optional IDs of the items to delete.
+     * @param array<string, string> $where Optional query condition to filter items to delete based on metadata values.
+     * @param array<string, string> $whereDocument Optional query condition to filter items to delete based on document content.
+     */
     public function __construct(
-        /**
-         * Optional IDs of the items to delete.
-         *
-         * @var string[]
-         */
         public readonly ?array $ids,
-
-        /**
-         * Optional query condition to filter items to delete based on metadata values.
-         *
-         * @var array<string, string>
-         */
         public readonly ?array $where,
-
-        /**
-         * Optional query condition to filter items to delete based on document content.
-         *
-         * @var array<string, string>
-         */
         public readonly ?array $whereDocument,
     ) {}
 

src/Requests/DeleteEmbeddingRequest.php

@@ -10,48 +10,22 @@
  */
 class GetEmbeddingRequest
 {
+    /**
+     * @param string[] $ids Optional IDs of the items to get.
+     * @param array<string, mixed> $where Optional where clause to filter items by.
+     * @param array<string, mixed> $whereDocument Optional where clause to filter items by.
+     * @param string $sort Optional sort items.
+     * @param int $limit Optional limit on the number of items to get.
+     * @param int $offset Optional offset on the number of items to get.
+     * @param string[] $include Optional list of items to include in the response.
+     */
     public function __construct(
-        /**
-         * Optional IDs of the items to get.
-         *
-         * @var string[]
-         */
         public readonly ?array $ids = null,
-
-        /**
-         * Optional where clause to filter items by.
-         *
-         * @var array<string, mixed>
-         */
         public readonly ?array $where = null,
-
-        /**
-         * Optional where clause to filter items by.
-         *
-         * @var array<string, mixed>
-         */
         public readonly ?array $whereDocument = null,
-
-        /**
-         * Sort items.
-         */
         public readonly ?string $sort = null,
-
-        /**
-         * Optional limit on the number of items to get.
-         */
         public readonly ?int $limit = null,
-
-        /**
-         * Optional offset on the number of items to get.
-         */
         public readonly ?int $offset = null,
-
-        /**
-         * Optional list of items to include in the response.
-         *
-         * @var string[]
-         */
         public readonly ?array $include = null,
     ) {}
 

src/Requests/GetEmbeddingRequest.php

@@ -7,38 +7,18 @@
 
 class QueryEmbeddingRequest
 {
+    /**
+     * @param array<string, string> $where Optional query condition to filter results based on metadata values.
+     * @param array<string, mixed> $whereDocument Optional query condition to filter results based on document content.
+     * @param float[][] $queryEmbeddings Optional query condition to filter results based on embedding content.
+     * @param int $nResults Optional number of results to return. Defaults to 10.
+     * @param string[] $include Optional list of items to include in the response.
+     */
     public function __construct(
-        /**
-         * Optional query condition to filter results based on metadata values.
-         *
-         * @var array<string, string>
-         */
         public readonly ?array $where,
-
-        /**
-         * Optional query condition to filter results based on document content.
-         *
-         * @var array<string, mixed>
-         */
         public readonly ?array $whereDocument,
-
-        /**
-         * Optional query condition to filter results based on embedding content.
-         *
-         * @var float[][]
-         */
         public readonly ?array $queryEmbeddings,
-
-        /**
-         * Optional number of results to return. Defaults to 10.
-         */
         public readonly ?int   $nResults,
-
-        /**
-         * Optional list of items to include in the response.
-         *
-         * @var string[]
-         */
         public readonly ?array $include,
     ) {}
 

src/Requests/QueryEmbeddingRequest.php

@@ -7,19 +7,13 @@
 
 class UpdateCollectionRequest
 {
+    /**
+     * @param mixed $newName New name of the collection.
+     * @param mixed $newMetadata New metadata of the collection.
+     */
     public function __construct(
-        /**
-         * New name of the collection.
-         */
         public readonly ?string $newName,
-
-        /**
-         * New metadata of the collection.
-         *
-         * @var array<string, string>
-         */
         public readonly ?array $newMetadata,
-
     ) {}
 
     public static function create(array $data): self

src/Requests/UpdateCollectionRequest.php

@@ -7,41 +7,18 @@
 
 class UpdateEmbeddingRequest
 {
+    /**
+     * @param float[][] $embeddings Optional embeddings of the items to update.
+     * @param string[] $ids IDs of the items to update.
+     * @param array<string, string> $metadatas Optional metadatas of the items to update.
+     * @param string[] $documents Optional documents of the items to update.
+     * @param string[] $images Optional images of the items to update.
+     */
     public function __construct(
-        /**
-         * Optional embeddings of the items to update.
-         *
-         * @var float[][]
-         */
         public readonly ?array $embeddings,
-
-
-        /**
-         * IDs of the items to update.
-         *
-         * @var string[]
-         */
         public readonly array  $ids,
-
-        /**
-         * Optional metadatas of the items to update.
-         *
-         * @var array<string, string>[]
-         */
         public readonly ?array $metadatas,
-
-        /**
-         * Optional documents of the items to update.
-         *
-         * @var string[]
-         */
         public readonly ?array $documents,
-
-        /**
-         * Optional uris of the items to update.
-         *
-         * @var string[]
-         */
         public readonly ?array $images,
     ) {}