@appwrite.io/console 6.0.0 → 7.0.0-rc.1

package/types/models.d.ts

@@ -695,6 +695,32 @@ export declare namespace Models {
          */
         contents: VcsContent[];
     };
+    /**
+     * VectorsDB Collections List
+     */
+    export type VectorsdbCollectionList = {
+        /**
+         * Total number of collections that matched your query.
+         */
+        total: number;
+        /**
+         * List of collections.
+         */
+        collections: VectorsdbCollection[];
+    };
+    /**
+     * Embedding list
+     */
+    export type EmbeddingList = {
+        /**
+         * Total number of embeddings that matched your query.
+         */
+        total: number;
+        /**
+         * List of embeddings.
+         */
+        embeddings: Embedding[];
+    };
     /**
      * Database
      */
@@ -732,6 +758,27 @@ export declare namespace Models {
          */
         archives: Collection[];
     };
+    /**
+     * Embedding
+     */
+    export type Embedding = {
+        /**
+         * Embedding model used to generate embeddings.
+         */
+        model: string;
+        /**
+         * Number of dimensions for each embedding vector.
+         */
+        dimension: number;
+        /**
+         * Embedding vector values. If an error occurs, this will be an empty array.
+         */
+        embedding: number[];
+        /**
+         * Error message if embedding generation fails. Empty string if no error.
+         */
+        error: string;
+    };
     /**
      * Collection
      */
@@ -1583,6 +1630,296 @@ export declare namespace Models {
          */
         encrypt?: boolean;
     };
+    /**
+     * UsageDocumentsDB
+     */
+    export type UsageDocumentsDB = {
+        /**
+         * Time range of the usage stats.
+         */
+        range: string;
+        /**
+         * Total aggregated number of collections.
+         */
+        collectionsTotal: number;
+        /**
+         * Total aggregated number of documents.
+         */
+        documentsTotal: number;
+        /**
+         * Total aggregated storage used in bytes.
+         */
+        storageTotal: number;
+        /**
+         * Total number of database reads.
+         */
+        databaseReadsTotal: number;
+        /**
+         * Total number of database writes.
+         */
+        databaseWritesTotal: number;
+        /**
+         * Aggregated number of collections per period.
+         */
+        collections: Metric[];
+        /**
+         * Aggregated number of documents per period.
+         */
+        documents: Metric[];
+        /**
+         * Aggregated storage used in bytes per period.
+         */
+        storage: Metric[];
+        /**
+         * An array of aggregated number of database reads.
+         */
+        databaseReads: Metric[];
+        /**
+         * An array of aggregated number of database writes.
+         */
+        databaseWrites: Metric[];
+    };
+    /**
+     * VectorsDB Collection
+     */
+    export type VectorsdbCollection = {
+        /**
+         * Collection ID.
+         */
+        $id: string;
+        /**
+         * Collection creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Collection update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
+         */
+        $permissions: string[];
+        /**
+         * Database ID.
+         */
+        databaseId: string;
+        /**
+         * Collection name.
+         */
+        name: string;
+        /**
+         * Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.
+         */
+        enabled: boolean;
+        /**
+         * Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions).
+         */
+        documentSecurity: boolean;
+        /**
+         * Collection attributes.
+         */
+        attributes: (Models.AttributeObject | Models.AttributeVector)[];
+        /**
+         * Collection indexes.
+         */
+        indexes: Index[];
+        /**
+         * Maximum document size in bytes. Returns 0 when no limit applies.
+         */
+        bytesMax: number;
+        /**
+         * Currently used document size in bytes based on defined attributes.
+         */
+        bytesUsed: number;
+        /**
+         * Embedding dimension.
+         */
+        dimension: number;
+    };
+    /**
+     * AttributeObject
+     */
+    export type AttributeObject = {
+        /**
+         * Attribute Key.
+         */
+        key: string;
+        /**
+         * Attribute type.
+         */
+        type: string;
+        /**
+         * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+         */
+        status: AttributeStatus;
+        /**
+         * Error message. Displays error generated on failure of creating or deleting an attribute.
+         */
+        error: string;
+        /**
+         * Is attribute required?
+         */
+        required: boolean;
+        /**
+         * Is attribute an array?
+         */
+        array?: boolean;
+        /**
+         * Attribute creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Attribute update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+    };
+    /**
+     * AttributeVector
+     */
+    export type AttributeVector = {
+        /**
+         * Attribute Key.
+         */
+        key: string;
+        /**
+         * Attribute type.
+         */
+        type: string;
+        /**
+         * Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`
+         */
+        status: AttributeStatus;
+        /**
+         * Error message. Displays error generated on failure of creating or deleting an attribute.
+         */
+        error: string;
+        /**
+         * Is attribute required?
+         */
+        required: boolean;
+        /**
+         * Is attribute an array?
+         */
+        array?: boolean;
+        /**
+         * Attribute creation date in ISO 8601 format.
+         */
+        $createdAt: string;
+        /**
+         * Attribute update date in ISO 8601 format.
+         */
+        $updatedAt: string;
+        /**
+         * Vector dimensions.
+         */
+        size: number;
+    };
+    /**
+     * UsageVectorsDBs
+     */
+    export type UsageVectorsDBs = {
+        /**
+         * Time range of the usage stats.
+         */
+        range: string;
+        /**
+         * Total aggregated number of VectorsDB databases.
+         */
+        databasesTotal: number;
+        /**
+         * Total aggregated number of collections.
+         */
+        collectionsTotal: number;
+        /**
+         * Total aggregated number of documents.
+         */
+        documentsTotal: number;
+        /**
+         * Total aggregated storage in bytes.
+         */
+        storageTotal: number;
+        /**
+         * Total number of database reads.
+         */
+        databasesReadsTotal: number;
+        /**
+         * Total number of database writes.
+         */
+        databasesWritesTotal: number;
+        /**
+         * Aggregated number of databases per period.
+         */
+        databases: Metric[];
+        /**
+         * Aggregated number of collections per period.
+         */
+        collections: Metric[];
+        /**
+         * Aggregated number of documents per period.
+         */
+        documents: Metric[];
+        /**
+         * Aggregated storage in bytes per period.
+         */
+        storage: Metric[];
+        /**
+         * An array of aggregated number of database reads.
+         */
+        databasesReads: Metric[];
+        /**
+         * An array of aggregated number of database writes.
+         */
+        databasesWrites: Metric[];
+    };
+    /**
+     * UsageVectorsDB
+     */
+    export type UsageVectorsDB = {
+        /**
+         * Time range of the usage stats.
+         */
+        range: string;
+        /**
+         * Total aggregated number of collections.
+         */
+        collectionsTotal: number;
+        /**
+         * Total aggregated number of documents.
+         */
+        documentsTotal: number;
+        /**
+         * Total aggregated storage used in bytes.
+         */
+        storageTotal: number;
+        /**
+         * Total number of database reads.
+         */
+        databaseReadsTotal: number;
+        /**
+         * Total number of database writes.
+         */
+        databaseWritesTotal: number;
+        /**
+         * Aggregated number of collections per period.
+         */
+        collections: Metric[];
+        /**
+         * Aggregated number of documents per period.
+         */
+        documents: Metric[];
+        /**
+         * Aggregated storage used in bytes per period.
+         */
+        storage: Metric[];
+        /**
+         * An array of aggregated number of database reads.
+         */
+        databaseReads: Metric[];
+        /**
+         * An array of aggregated number of database writes.
+         */
+        databaseWrites: Metric[];
+    };
     /**
      * Table
      */
@@ -2535,7 +2872,7 @@ export declare namespace Models {
         /**
          * Row sequence ID.
          */
-        $sequence: number;
+        $sequence: string;
         /**
          * Table ID.
          */
@@ -2572,7 +2909,7 @@ export declare namespace Models {
         /**
          * Document sequence ID.
          */
-        $sequence: number;
+        $sequence: string;
         /**
          * Collection ID.
          */
@@ -5859,9 +6196,13 @@ export declare namespace Models {
          */
         executionsTotal: number;
         /**
-         * Total aggregated  number of documents.
+         * Total aggregated  number of documents in legacy/tablesdb.
          */
         documentsTotal: number;
+        /**
+         * Total aggregated  number of documents in documentsdb.
+         */
+        documentsdbDocumentsTotal: number;
         /**
          * Total aggregated  number of rows.
          */
@@ -5870,10 +6211,18 @@ export declare namespace Models {
          * Total aggregated number of databases.
          */
         databasesTotal: number;
+        /**
+         * Total aggregated number of documentsdb.
+         */
+        documentsdbTotal: number;
         /**
          * Total aggregated sum of databases storage size (in bytes).
          */
         databasesStorageTotal: number;
+        /**
+         * Total aggregated sum of documentsdb databases storage size (in bytes).
+         */
+        documentsdbDatabasesStorageTotal: number;
         /**
          * Total aggregated number of users.
          */
@@ -5914,6 +6263,14 @@ export declare namespace Models {
          * Aggregated stats for total databases writes.
          */
         databasesWritesTotal: number;
+        /**
+         * Total number of documentsdb databases reads.
+         */
+        documentsdbDatabasesReadsTotal: number;
+        /**
+         * Total number of documentsdb databases writes.
+         */
+        documentsdbDatabasesWritesTotal: number;
         /**
          * Aggregated  number of requests per period.
          */
@@ -5974,6 +6331,18 @@ export declare namespace Models {
          * Aggregated stats for database writes.
          */
         databasesWrites: Metric[];
+        /**
+         * An array of aggregated number of documentsdb database reads.
+         */
+        documentsdbDatabasesReads: Metric[];
+        /**
+         * An array of aggregated number of documentsdb database writes.
+         */
+        documentsdbDatabasesWrites: Metric[];
+        /**
+         * An array of aggregated sum of documentsdb databases storage size (in bytes) per period.
+         */
+        documentsdbDatabasesStorage: Metric[];
         /**
          * An array of aggregated number of image transformations.
          */
@@ -5982,6 +6351,86 @@ export declare namespace Models {
          * Total aggregated number of image transformations.
          */
         imageTransformationsTotal: number;
+        /**
+         * Total aggregated number of VectorsDB databases.
+         */
+        vectorsdbDatabasesTotal: number;
+        /**
+         * Total aggregated number of VectorsDB collections.
+         */
+        vectorsdbCollectionsTotal: number;
+        /**
+         * Total aggregated number of VectorsDB documents.
+         */
+        vectorsdbDocumentsTotal: number;
+        /**
+         * Total aggregated VectorsDB storage (bytes).
+         */
+        vectorsdbDatabasesStorageTotal: number;
+        /**
+         * Total aggregated number of VectorsDB reads.
+         */
+        vectorsdbDatabasesReadsTotal: number;
+        /**
+         * Total aggregated number of VectorsDB writes.
+         */
+        vectorsdbDatabasesWritesTotal: number;
+        /**
+         * Aggregated VectorsDB databases per period.
+         */
+        vectorsdbDatabases: Metric[];
+        /**
+         * Aggregated VectorsDB collections per period.
+         */
+        vectorsdbCollections: Metric[];
+        /**
+         * Aggregated VectorsDB documents per period.
+         */
+        vectorsdbDocuments: Metric[];
+        /**
+         * Aggregated VectorsDB storage per period.
+         */
+        vectorsdbDatabasesStorage: Metric[];
+        /**
+         * Aggregated VectorsDB reads per period.
+         */
+        vectorsdbDatabasesReads: Metric[];
+        /**
+         * Aggregated VectorsDB writes per period.
+         */
+        vectorsdbDatabasesWrites: Metric[];
+        /**
+         * Aggregated number of text embedding calls per period.
+         */
+        embeddingsText: Metric;
+        /**
+         * Aggregated number of tokens processed by text embeddings per period.
+         */
+        embeddingsTextTokens: Metric;
+        /**
+         * Aggregated duration spent generating text embeddings per period.
+         */
+        embeddingsTextDuration: Metric;
+        /**
+         * Aggregated number of errors while generating text embeddings per period.
+         */
+        embeddingsTextErrors: Metric;
+        /**
+         * Total aggregated number of text embedding calls.
+         */
+        embeddingsTextTotal: Metric;
+        /**
+         * Total aggregated number of tokens processed by text.
+         */
+        embeddingsTextTokensTotal: Metric;
+        /**
+         * Total aggregated duration spent generating text embeddings.
+         */
+        embeddingsTextDurationTotal: Metric;
+        /**
+         * Total aggregated number of errors while generating text embeddings.
+         */
+        embeddingsTextErrorsTotal: Metric;
         /**
          * Aggregated number of function executions per period.
          */

package/types/services/databases.d.ts

@@ -3,7 +3,7 @@ import type { Models } from '../models';
 import { UsageRange } from '../enums/usage-range';
 import { RelationshipType } from '../enums/relationship-type';
 import { RelationMutate } from '../enums/relation-mutate';
-import { IndexType } from '../enums/index-type';
+import { DatabasesIndexType } from '../enums/databases-index-type';
 import { OrderBy } from '../enums/order-by';
 export declare class Databases {
     client: Client;
@@ -2249,7 +2249,7 @@ export declare class Databases {
      * @param {string} params.databaseId - Database ID.
      * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @param {string} params.key - Index Key.
-     * @param {IndexType} params.type - Index type.
+     * @param {DatabasesIndexType} params.type - Index type.
      * @param {string[]} params.attributes - Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
      * @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
      * @param {number[]} params.lengths - Length of index. Maximum of 100
@@ -2261,7 +2261,7 @@ export declare class Databases {
         databaseId: string;
         collectionId: string;
         key: string;
-        type: IndexType;
+        type: DatabasesIndexType;
         attributes: string[];
         orders?: OrderBy[];
         lengths?: number[];
@@ -2273,7 +2273,7 @@ export declare class Databases {
      * @param {string} databaseId - Database ID.
      * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
      * @param {string} key - Index Key.
-     * @param {IndexType} type - Index type.
+     * @param {DatabasesIndexType} type - Index type.
      * @param {string[]} attributes - Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
      * @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
      * @param {number[]} lengths - Length of index. Maximum of 100
@@ -2281,7 +2281,7 @@ export declare class Databases {
      * @returns {Promise<Models.Index>}
      * @deprecated Use the object parameter style method for a better developer experience.
      */
-    createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.Index>;
+    createIndex(databaseId: string, collectionId: string, key: string, type: DatabasesIndexType, attributes: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.Index>;
     /**
      * Get an index by its unique ID.
      *