@appwrite.io/console 15.2.0 → 15.3.0

package/types/services/vectors-db.d.ts

@@ -1,7 +1,6 @@
 import { Client } from '../client';
 import type { Models } from '../models';
 import { EmbeddingModel } from '../enums/embedding-model';
-import { UsageRange } from '../enums/usage-range';
 import { VectorsDBIndexType } from '../enums/vectors-db-index-type';
 import { OrderBy } from '../enums/order-by';
 export declare class VectorsDB {
@@ -36,7 +35,7 @@ export declare class VectorsDB {
      * @param {string} params.databaseId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
      * @param {string} params.name - Database name. Max length: 128 chars.
      * @param {boolean} params.enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
-     * @param {string} params.dedicatedDatabaseId - Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.
+     * @param {string} params.specification - Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Database>}
      */
@@ -44,7 +43,7 @@ export declare class VectorsDB {
         databaseId: string;
         name: string;
         enabled?: boolean;
-        dedicatedDatabaseId?: string;
+        specification?: string;
     }): Promise<Models.Database>;
     /**
      * Create a new Database.
@@ -53,14 +52,15 @@ export declare class VectorsDB {
      * @param {string} databaseId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
      * @param {string} name - Database name. Max length: 128 chars.
      * @param {boolean} enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
-     * @param {string} dedicatedDatabaseId - Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.
+     * @param {string} specification - Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.
      * @throws {AppwriteException}
      * @returns {Promise<Models.Database>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    create(databaseId: string, name: string, enabled?: boolean, dedicatedDatabaseId?: string): Promise<Models.Database>;
+    create(databaseId: string, name: string, enabled?: boolean, specification?: string): Promise<Models.Database>;
     /**
-     * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#documentsDBCreateCollection) API or directly from your database console.
+     * Generate vector embeddings for an array of text using the selected embedding model. Use the returned vectors to power semantic search and similarity queries against your vector collections.
+     *
      *
      * @param {string[]} params.texts - Array of text to generate embeddings.
      * @param {EmbeddingModel} params.model - The embedding model to use for generating vector embeddings.
@@ -72,7 +72,8 @@ export declare class VectorsDB {
         model?: EmbeddingModel;
     }): Promise<Models.EmbeddingList>;
     /**
-     * Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#documentsDBCreateCollection) API or directly from your database console.
+     * Generate vector embeddings for an array of text using the selected embedding model. Use the returned vectors to power semantic search and similarity queries against your vector collections.
+     *
      *
      * @param {string[]} texts - Array of text to generate embeddings.
      * @param {EmbeddingModel} model - The embedding model to use for generating vector embeddings.
@@ -204,25 +205,6 @@ export declare class VectorsDB {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     createOperations(transactionId: string, operations?: object[]): Promise<Models.Transaction>;
-    /**
-     * List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
-     *
-     * @param {UsageRange} params.range - Date range.
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.UsageVectorsDBs>}
-     */
-    listUsage(params?: {
-        range?: UsageRange;
-    }): Promise<Models.UsageVectorsDBs>;
-    /**
-     * List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
-     *
-     * @param {UsageRange} range - Date range.
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.UsageVectorsDBs>}
-     * @deprecated Use the object parameter style method for a better developer experience.
-     */
-    listUsage(range?: UsageRange): Promise<Models.UsageVectorsDBs>;
     /**
      * Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.
      *
@@ -855,51 +837,4 @@ export declare class VectorsDB {
      * @deprecated Use the object parameter style method for a better developer experience.
      */
     deleteIndex(databaseId: string, collectionId: string, key: string): Promise<{}>;
-    /**
-     * Get usage metrics and statistics for a collection. Returning the total number of documents. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
-     *
-     * @param {string} params.databaseId - Database ID.
-     * @param {string} params.collectionId - Collection ID.
-     * @param {UsageRange} params.range - Date range.
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.UsageCollection>}
-     */
-    getCollectionUsage(params: {
-        databaseId: string;
-        collectionId: string;
-        range?: UsageRange;
-    }): Promise<Models.UsageCollection>;
-    /**
-     * Get usage metrics and statistics for a collection. Returning the total number of documents. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
-     *
-     * @param {string} databaseId - Database ID.
-     * @param {string} collectionId - Collection ID.
-     * @param {UsageRange} range - Date range.
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.UsageCollection>}
-     * @deprecated Use the object parameter style method for a better developer experience.
-     */
-    getCollectionUsage(databaseId: string, collectionId: string, range?: UsageRange): Promise<Models.UsageCollection>;
-    /**
-     * Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
-     *
-     * @param {string} params.databaseId - Database ID.
-     * @param {UsageRange} params.range - Date range.
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.UsageVectorsDB>}
-     */
-    getUsage(params: {
-        databaseId: string;
-        range?: UsageRange;
-    }): Promise<Models.UsageVectorsDB>;
-    /**
-     * Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.
-     *
-     * @param {string} databaseId - Database ID.
-     * @param {UsageRange} range - Date range.
-     * @throws {AppwriteException}
-     * @returns {Promise<Models.UsageVectorsDB>}
-     * @deprecated Use the object parameter style method for a better developer experience.
-     */
-    getUsage(databaseId: string, range?: UsageRange): Promise<Models.UsageVectorsDB>;
 }