arangojs 7.8.0 → 8.0.0

package/analyzer.d.ts

@@ -8,7 +8,7 @@
  *
  * @packageDocumentation
  */
-import { ArangoResponseMetadata } from "./connection";
+import { ArangoApiResponse } from "./connection";
 import { Database } from "./database";
 /**
  * Indicates whether the given value represents an {@link Analyzer}.
@@ -19,50 +19,42 @@ export declare function isArangoAnalyzer(analyzer: any): analyzer is Analyzer;
 /**
  * Name of a feature enabled for an Analyzer.
  */
-export declare type AnalyzerFeature = "frequency" | "norm" | "position";
-/**
- * An object describing an Analyzer.
- */
-export declare type AnalyzerDescription = AnalyzerInfo & {
-    name: string;
-    features: AnalyzerFeature[];
-};
-/**
- * Options for creating an Analyzer.
- */
-export declare type CreateAnalyzerOptions = AnalyzerInfo & {
-    /**
-     * Features to enable for this Analyzer.
-     */
-    features?: AnalyzerFeature[];
-};
+export declare type AnalyzerFeature = "frequency" | "norm" | "position" | "offset";
 /**
  * Analyzer type and its type-specific properties.
  */
-export declare type AnalyzerInfo = IdentityAnalyzerInfo | DelimiterAnalyzerInfo | StemAnalyzerInfo | NormAnalyzerInfo | NgramAnalyzerInfo | TextAnalyzerInfo | PipelineAnalyzer | AqlAnalyzer | GeoJsonAnalyzer | GeoPointAnalyzer | StopwordsAnalyzer | SegmentationAnalyzer | CollationAnalyzer;
+export declare type CreateAnalyzerOptions = CreateIdentityAnalyzerOptions | CreateDelimiterAnalyzerOptions | CreateStemAnalyzerOptions | CreateNormAnalyzerOptions | CreateNgramAnalyzerOptions | CreateTextAnalyzerOptions | CreateSegmentationAnalyzerOptions | CreateAqlAnalyzerOptions | CreatePipelineAnalyzerOptions | CreateStopwordsAnalyzerOptions | CreateCollationAnalyzerOptions | CreateMinHashAnalyzerOptions | CreateClassificationAnalyzerOptions | CreateNearestNeighborsAnalyzerOptions | CreateGeoJsonAnalyzerOptions | CreateGeoPointAnalyzerOptions;
 /**
- * Analyzer type and type-specific properties for an Identity Analyzer.
+ * Options for creating an Identity Analyzer.
  */
-export declare type IdentityAnalyzerInfo = {
+export declare type CreateIdentityAnalyzerOptions = {
     /**
      * Type of the Analyzer.
      */
     type: "identity";
+    /**
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
     /**
      * Additional properties for the Analyzer.
      *
      * The `identity` Analyzer does not take additional properties.
      */
-    properties?: null;
+    properties?: Record<string, never>;
 };
 /**
- * Analyzer type and type-specific properties for a Delimiter Analyzer.
+ * Options for creating a Delimiter Analyzer.
  */
-export declare type DelimiterAnalyzerInfo = {
+export declare type CreateDelimiterAnalyzerOptions = {
     /**
      * Type of the Analyzer.
      */
     type: "delimiter";
+    /**
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
     /**
      * Additional properties for the Analyzer.
      *
@@ -74,13 +66,17 @@ export declare type DelimiterAnalyzerInfo = {
     };
 };
 /**
- * Analyzer type and type-specific properties for a Stem Analyzer.
+ * Options for creating a Stem Analyzer.
  */
-export declare type StemAnalyzerInfo = {
+export declare type CreateStemAnalyzerOptions = {
     /**
      * Type of the Analyzer.
      */
     type: "stem";
+    /**
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
     /**
      * Additional properties for the Analyzer.
      *
@@ -93,377 +89,659 @@ export declare type StemAnalyzerInfo = {
     };
 };
 /**
- * Properties of a Norm Analyzer.
+ * Options for creating a Norm Analyzer.
  */
-export declare type NormAnalyzerProperties = {
+export declare type CreateNormAnalyzerOptions = {
     /**
-     * Text locale.
-     *
-     * Format: `language[_COUNTRY][.encoding][@variant]`
+     * Type of the Analyzer.
      */
-    locale: string;
+    type: "norm";
     /**
-     * Case conversion.
-     *
-     * Default: `"lower"`
+     * Features to enable for this Analyzer.
      */
-    case?: "lower" | "none" | "upper";
+    features?: AnalyzerFeature[];
     /**
-     * Preserve accents in returned words.
-     *
-     * Default: `false`
+     * Additional properties for the Analyzer.
      */
-    accent?: boolean;
+    properties: {
+        /**
+         * Text locale.
+         *
+         * Format: `language[_COUNTRY][.encoding][@variant]`
+         */
+        locale: string;
+        /**
+         * Case conversion.
+         *
+         * Default: `"lower"`
+         */
+        case?: "lower" | "none" | "upper";
+        /**
+         * Preserve accents in returned words.
+         *
+         * Default: `false`
+         */
+        accent?: boolean;
+    };
 };
 /**
- * Analyzer type and type-specific properties for a Norm Analyzer.
+ * Options for creating an Ngram Analyzer.
  */
-export declare type NormAnalyzerInfo = {
+export declare type CreateNgramAnalyzerOptions = {
     /**
      * Type of the Analyzer.
      */
-    type: "norm";
+    type: "ngram";
+    /**
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
     /**
      * Additional properties for the Analyzer.
      */
-    properties: NormAnalyzerProperties;
+    properties: {
+        /**
+         * Maximum n-gram length.
+         */
+        max: number;
+        /**
+         * Minimum n-gram length.
+         */
+        min: number;
+        /**
+         * Output the original value as well.
+         */
+        preserveOriginal: boolean;
+    };
 };
 /**
- * Properties of an Ngram Analyzer.
+ * Options for creating a Text Analyzer.
  */
-export declare type NgramAnalyzerProperties = {
+export declare type CreateTextAnalyzerOptions = {
     /**
-     * Maximum n-gram length.
+     * Type of the Analyzer.
      */
-    max: number;
+    type: "text";
     /**
-     * Minimum n-gram length.
+     * Features to enable for this Analyzer.
      */
-    min: number;
+    features?: AnalyzerFeature[];
     /**
-     * Output the original value as well.
+     * Additional properties for the Analyzer.
      */
-    preserveOriginal: boolean;
+    properties: {
+        /**
+         * Text locale.
+         *
+         * Format: `language[_COUNTRY][.encoding][@variant]`
+         */
+        locale: string;
+        /**
+         * Case conversion.
+         *
+         * Default: `"lower"`
+         */
+        case?: "lower" | "none" | "upper";
+        /**
+         * Words to omit from result.
+         *
+         * Defaults to the words loaded from the file at `stopwordsPath`.
+         */
+        stopwords?: string[];
+        /**
+         * Path with a `language` sub-directory containing files with words to omit.
+         *
+         * Defaults to the path specified in the server-side environment variable
+         * `IRESEARCH_TEXT_STOPWORD_PATH` or the current working directory of the
+         * ArangoDB process.
+         */
+        stopwordsPath?: string;
+        /**
+         * Preserve accents in returned words.
+         *
+         * Default: `false`
+         */
+        accent?: boolean;
+        /**
+         * Apply stemming on returned words.
+         *
+         * Default: `true`
+         */
+        stemming?: boolean;
+        /**
+         * If present, then edge n-grams are generated for each token (word).
+         */
+        edgeNgram?: {
+            min?: number;
+            max?: number;
+            preserveOriginal?: boolean;
+        };
+    };
 };
 /**
- * Analyzer type and type-specific properties for an Ngram Analyzer.
+ * Options for creating a Segmentation Analyzer
  */
-export declare type NgramAnalyzerInfo = {
+export declare type CreateSegmentationAnalyzerOptions = {
     /**
      * Type of the Analyzer.
      */
-    type: "ngram";
+    type: "segmentation";
+    /**
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
     /**
      * Additional properties for the Analyzer.
      */
-    properties: NgramAnalyzerProperties;
+    properties: {
+        /**
+         * Which tokens should be returned.
+         *
+         * Default: `"alpha"`
+         */
+        break?: "all" | "alpha" | "graphic";
+        /**
+         * What case all returned tokens should be converted to if applicable.
+         *
+         * Default: `"none"`
+         */
+        case?: "lower" | "upper" | "none";
+    };
 };
 /**
- * Properties of a Text Analyzer.
+ * Options for creating an AQL Analyzer
  */
-export declare type TextAnalyzerProperties = {
-    /**
-     * Text locale.
-     *
-     * Format: `language[_COUNTRY][.encoding][@variant]`
-     */
-    locale: string;
-    /**
-     * Case conversion.
-     *
-     * Default: `"lower"`
-     */
-    case?: "lower" | "none" | "upper";
+export declare type CreateAqlAnalyzerOptions = {
     /**
-     * Words to omit from result.
-     *
-     * Defaults to the words loaded from the file at `stopwordsPath`.
-     */
-    stopwords?: string[];
-    /**
-     * Path with a `language` sub-directory containing files with words to omit.
-     *
-     * Defaults to the path specified in the server-side environment variable
-     * `IRESEARCH_TEXT_STOPWORD_PATH` or the current working directory of the
-     * ArangoDB process.
-     */
-    stopwordsPath?: string;
-    /**
-     * Preserve accents in returned words.
-     *
-     * Default: `false`
+     * Type of the Analyzer.
      */
-    accent?: boolean;
+    type: "aql";
     /**
-     * Apply stemming on returned words.
-     *
-     * Default: `true`
+     * Features to enable for this Analyzer.
      */
-    stemming?: boolean;
+    features?: AnalyzerFeature[];
     /**
-     * If present, then edge n-grams are generated for each token (word).
+     * Additional properties for the Analyzer.
      */
-    edgeNgram?: {
-        min?: number;
-        max?: number;
-        preserveOriginal?: boolean;
+    properties: {
+        /**
+         * AQL query to be executed.
+         */
+        queryString: string;
+        /**
+         * If set to `true`, the position is set to `0` for all members of the query result array.
+         *
+         * Default: `false`
+         */
+        collapsePositions?: boolean;
+        /**
+         * If set to `false`, `null` values will be discarded from the View index.
+         *
+         * Default: `true`
+         */
+        keepNull?: boolean;
+        /**
+         * Number between `1` and `1000` that determines the batch size for reading
+         * data from the query.
+         *
+         * Default: `1`
+         */
+        batchSize?: number;
+        /**
+         * Memory limit for query execution in bytes.
+         *
+         * Default: `1048576` (1 MiB)
+         */
+        memoryLimit?: number;
+        /**
+         * Data type of the returned tokens.
+         *
+         * Default: `"string"`
+         */
+        returnType?: "string" | "number" | "bool";
     };
 };
 /**
- * Analyzer type and type-specific properties for a Text Analyzer.
+ * Options for creating a Pipeline Analyzer
  */
-export declare type TextAnalyzerInfo = {
+export declare type CreatePipelineAnalyzerOptions = {
     /**
      * Type of the Analyzer.
      */
-    type: "text";
+    type: "pipeline";
     /**
-     * Additional properties for the Analyzer.
+     * Features to enable for this Analyzer.
      */
-    properties: TextAnalyzerProperties;
-};
-/**
- * Properties of a Pipeline Analyzer.
- */
-export declare type PipelineAnalyzerProperties = {
+    features?: AnalyzerFeature[];
     /**
-     * Definitions for Analyzers to chain in this Pipeline Analyzer.
+     * Additional properties for the Analyzer.
      */
-    pipeline: AnalyzerInfo[];
+    properties: {
+        /**
+         * Definitions for Analyzers to chain in this Pipeline Analyzer.
+         */
+        pipeline: Omit<CreateAnalyzerOptions, "features">[];
+    };
 };
 /**
- * Analyzer type and type-specific properties for a Pipeline Analyzer
+ * Options for creating a Stopwords Analyzer
  */
-export declare type PipelineAnalyzer = {
+export declare type CreateStopwordsAnalyzerOptions = {
     /**
      * Type of the Analyzer.
      */
-    type: "pipeline";
+    type: "stopwords";
+    /**
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
     /**
      * Additional properties for the Analyzer.
      */
-    properties: PipelineAnalyzerProperties;
+    properties: {
+        /**
+         * Array of strings that describe the tokens to be discarded.
+         */
+        stopwords: string[];
+        /**
+         * Whether stopword values should be interpreted as hex-encoded strings.
+         *
+         * Default: `false`
+         */
+        hex?: boolean;
+    };
 };
 /**
- * Properties of an AQL Analyzer.
+ * Options for creating a Collation Analyzer
  */
-export declare type AqlAnalyzerProperties = {
-    /**
-     * AQL query to be executed.
-     */
-    queryString: string;
+export declare type CreateCollationAnalyzerOptions = {
     /**
-     * If set to `true`, the position is set to `0` for all members of the query result array.
-     *
-     * Default: `false`
-     */
-    collapsePositions?: boolean;
-    /**
-     * If set to `false`, `null` values will be discarded from the View index.
-     *
-     * Default: `true`
-     */
-    keepNull?: boolean;
-    /**
-     * Number between `1` and `1000` that determines the batch size for reading
-     * data from the query.
-     *
-     * Default: `1`
+     * Type of the Analyzer.
      */
-    batchSize?: number;
+    type: "collation";
     /**
-     * Memory limit for query execution in bytes.
-     *
-     * Default: `1048576` (1 MiB)
+     * Features to enable for this Analyzer.
      */
-    memoryLimit?: number;
+    features?: AnalyzerFeature[];
     /**
-     * Data type of the returned tokens.
-     *
-     * Default: `"string"`
+     * Additional properties for the Analyzer.
      */
-    returnType?: "string" | "number" | "bool";
+    properties: {
+        /**
+         * Text locale.
+         *
+         * Format: `language[_COUNTRY][.encoding][@variant]`
+         */
+        locale: string;
+    };
 };
 /**
- * Analyzer type and type-specific properties for an AQL Analyzer
+ * Options for creating a MinHash Analyzer
  */
-export declare type AqlAnalyzer = {
+export declare type CreateMinHashAnalyzerOptions = {
     /**
      * Type of the Analyzer.
      */
-    type: "aql";
+    type: "minhash";
+    /**
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
     /**
      * Additional properties for the Analyzer.
      */
-    properties: AqlAnalyzerProperties;
+    properties: {
+        /**
+         * An Analyzer definition-like object with `type` and `properties` attributes.
+         */
+        analyzer: Omit<CreateAnalyzerOptions, "features">;
+        /**
+         * Size of the MinHash signature.
+         */
+        numHashes: number;
+    };
 };
 /**
- * Properties of a GeoJSON Analyzer.
+ * Options for creating a Classification Analyzer
  */
-export declare type GeoJsonAnalyzerProperties = {
+export declare type CreateClassificationAnalyzerOptions = {
     /**
-     * If set to `"centroid"`, only the centroid of the input geometry will be
-     * computed and indexed.
-     *
-     * If set to `"point"` only GeoJSON objects of type Point will be indexed and
-     * all other geometry types will be ignored.
-     *
-     * Default: `"shape"`
+     * Type of the Analyzer.
      */
-    type?: "shape" | "centroid" | "point";
+    type: "classification";
     /**
-     * Options for fine-tuning geo queries.
-     *
-     * Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
+    /**
+     * Additional properties for the Analyzer.
      */
-    options?: {
-        maxCells?: number;
-        minLevel?: number;
-        maxLevel?: number;
+    properties: {
+        /**
+         * On-disk path to the trained fastText supervised model.
+         */
+        model_location: string;
+        /**
+         * Number of class labels that will be produced per input.
+         *
+         * Default: `1`
+         */
+        top_k?: number;
+        /**
+         * Probability threshold for which a label will be assigned to an input.
+         *
+         * Default: `0.99`
+         */
+        threshold?: number;
     };
 };
 /**
- * Analyzer type and type-specific properties for a GeoJSON Analyzer
+ * Options for creating a NearestNeighbors Analyzer
  */
-export declare type GeoJsonAnalyzer = {
+export declare type CreateNearestNeighborsAnalyzerOptions = {
     /**
      * Type of the Analyzer.
      */
-    type: "geojson";
+    type: "nearest_neighbors";
+    /**
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
     /**
      * Additional properties for the Analyzer.
      */
-    properties: GeoJsonAnalyzerProperties;
+    properties: {
+        /**
+         * On-disk path to the trained fastText supervised model.
+         */
+        model_location: string;
+        /**
+         * Number of class labels that will be produced per input.
+         *
+         * Default: `1`
+         */
+        top_k?: number;
+    };
 };
 /**
- * Properties of a GeoPoint Analyzer.
+ * Options for creating a GeoJSON Analyzer
  */
-export declare type GeoPointAnalyzerProperties = {
+export declare type CreateGeoJsonAnalyzerOptions = {
     /**
-     * Attribute paths of the latitude value relative to the field for which the
-     * Analyzer is defined in the View.
+     * Type of the Analyzer.
      */
-    latitude?: string[];
+    type: "geojson";
     /**
-     * Attribute paths of the longitude value relative to the field for which the
-     * Analyzer is defined in the View.
+     * Features to enable for this Analyzer.
      */
-    longitude?: string[];
+    features?: AnalyzerFeature[];
     /**
-     * Options for fine-tuning geo queries.
-     *
-     * Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`
+     * Additional properties for the Analyzer.
      */
-    options?: {
-        minCells?: number;
-        minLevel?: number;
-        maxLevel?: number;
+    properties: {
+        /**
+         * If set to `"centroid"`, only the centroid of the input geometry will be
+         * computed and indexed.
+         *
+         * If set to `"point"` only GeoJSON objects of type Point will be indexed and
+         * all other geometry types will be ignored.
+         *
+         * Default: `"shape"`
+         */
+        type?: "shape" | "centroid" | "point";
+        /**
+         * Options for fine-tuning geo queries.
+         *
+         * Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`
+         */
+        options?: {
+            maxCells?: number;
+            minLevel?: number;
+            maxLevel?: number;
+        };
     };
 };
 /**
- * Analyzer type and type-specific properties for a GeoPoint Analyzer
+ * Options for creating a GeoPoint Analyzer
  */
-export declare type GeoPointAnalyzer = {
+export declare type CreateGeoPointAnalyzerOptions = {
     /**
      * Type of the Analyzer.
      */
     type: "geopoint";
+    /**
+     * Features to enable for this Analyzer.
+     */
+    features?: AnalyzerFeature[];
     /**
      * Additional properties for the Analyzer.
      */
-    properties: GeoPointAnalyzerProperties;
+    properties: {
+        /**
+         * Attribute paths of the latitude value relative to the field for which the
+         * Analyzer is defined in the View.
+         */
+        latitude?: string[];
+        /**
+         * Attribute paths of the longitude value relative to the field for which the
+         * Analyzer is defined in the View.
+         */
+        longitude?: string[];
+        /**
+         * Options for fine-tuning geo queries.
+         *
+         * Default: `{ maxCells: 20, minLevel: 4, maxLevel: 23 }`
+         */
+        options?: {
+            minCells?: number;
+            minLevel?: number;
+            maxLevel?: number;
+        };
+    };
 };
 /**
- * Properties of a Stopwords Analyzer.
+ * Shared attributes of all Analyzer descriptions.
  */
-export declare type StopwordsAnalyzerProperties = {
+export declare type GenericAnalyzerDescription = {
     /**
-     * Array of strings that describe the tokens to be discarded.
+     * A unique name for this Analyzer.
      */
-    stopwords: string[];
+    name: string;
     /**
-     * Whether stopword values should be interpreted as hex-encoded strings.
-     *
-     * Default: `false`
+     * Features enabled for this Analyzer.
      */
-    hex?: boolean;
+    features: AnalyzerFeature[];
 };
 /**
- * Analyzer type and type-specific properties for a Stopwords Analyzer
+ * An object describing an Analyzer.
  */
-export declare type StopwordsAnalyzer = {
-    /**
-     * Type of the Analyzer.
-     */
-    type: "stopwords";
-    /**
-     * Additional properties for the Analyzer.
-     */
-    properties: StopwordsAnalyzerProperties;
+export declare type AnalyzerDescription = IdentityAnalyzerDescription | DelimiterAnalyzerDescription | StemAnalyzerDescription | NormAnalyzerDescription | NgramAnalyzerDescription | TextAnalyzerDescription | SegmentationAnalyzerDescription | AqlAnalyzerDescription | PipelineAnalyzerDescription | StopwordsAnalyzerDescription | CollationAnalyzerDescription | MinHashAnalyzerDescription | ClassificationAnalyzerDescription | NearestNeighborsAnalyzerDescription | GeoJsonAnalyzerDescription | GeoPointAnalyzerDescription;
+/**
+ * An object describing an Identity Analyzer.
+ */
+export declare type IdentityAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "identity";
+    properties: Record<string, never>;
 };
 /**
- * Properties of a Segmentation Analyzer.
+ * An object describing a Delimiter Analyzer.
  */
-export declare type SegmentationAnalyzerProperties = {
-    /**
-     * Which tokens should be returned.
-     *
-     * Default: `"alpha"`
-     */
-    break?: "all" | "alpha" | "graphic";
-    /**
-     * What case all returned tokens should be converted to if applicable.
-     *
-     * Default: `"none"`
-     */
-    case?: "lower" | "upper" | "none";
+export declare type DelimiterAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "delimiter";
+    properties: {
+        delimiter: string;
+    };
 };
 /**
- * Analyzer type and type-specific properties for a Segmentation Analyzer
+ * An object describing a Stem Analyzer.
  */
-export declare type SegmentationAnalyzer = {
-    /**
-     * Type of the Analyzer.
-     */
+export declare type StemAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "stem";
+    properties: {
+        locale: string;
+    };
+};
+/**
+ * An object describing a Norm Analyzer.
+ */
+export declare type NormAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "norm";
+    properties: {
+        locale: string;
+        case: "lower" | "none" | "upper";
+        accent: boolean;
+    };
+};
+/**
+ * An object describing an Ngram Analyzer.
+ */
+export declare type NgramAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "ngram";
+    properties: {
+        max: number;
+        min: number;
+        preserveOriginal: boolean;
+    };
+};
+/**
+ * An object describing a Text Analyzer.
+ */
+export declare type TextAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "text";
+    properties: {
+        locale: string;
+        case: "lower" | "none" | "upper";
+        stopwords: string[];
+        stopwordsPath: string;
+        accent: boolean;
+        stemming: boolean;
+        edgeNgram: {
+            min: number;
+            max: number;
+            preserveOriginal: boolean;
+        };
+    };
+};
+/**
+ * An object describing a Segmentation Analyzer
+ */
+export declare type SegmentationAnalyzerDescription = GenericAnalyzerDescription & {
     type: "segmentation";
-    /**
-     * Additional properties for the Analyzer.
-     */
-    properties: SegmentationAnalyzerProperties;
+    properties: {
+        break: "all" | "alpha" | "graphic";
+        case: "lower" | "upper" | "none";
+    };
 };
 /**
- * Properties of a Collation Analyzer.
+ * An object describing an AQL Analyzer
  */
-export declare type CollationAnalyzerProperties = {
-    /**
-     * Text locale.
-     *
-     * Format: `language[_COUNTRY][.encoding][@variant]`
-     */
-    locale: string;
+export declare type AqlAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "aql";
+    properties: {
+        queryString: string;
+        collapsePositions: boolean;
+        keepNull: boolean;
+        batchSize: number;
+        memoryLimit: number;
+        returnType: "string" | "number" | "bool";
+    };
 };
 /**
- * Analyzer type and type-specific properties for a Collation Analyzer
+ * An object describing a Pipeline Analyzer
  */
-export declare type CollationAnalyzer = {
-    /**
-     * Type of the Analyzer.
-     */
+export declare type PipelineAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "pipeline";
+    properties: {
+        pipeline: Omit<AnalyzerDescription, "name" | "features">[];
+    };
+};
+/**
+ * An object describing a Stopwords Analyzer
+ */
+export declare type StopwordsAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "stopwords";
+    properties: {
+        stopwords: string[];
+        hex: boolean;
+    };
+};
+/**
+ * An object describing a Collation Analyzer
+ */
+export declare type CollationAnalyzerDescription = GenericAnalyzerDescription & {
     type: "collation";
-    /**
-     * Additional properties for the Analyzer.
-     */
-    properties: CollationAnalyzerProperties;
+    properties: {
+        locale: string;
+    };
+};
+/**
+ * (Enterprise Edition only.) An object describing a MinHash Analyzer
+ */
+export declare type MinHashAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "minhash";
+    properties: {
+        analyzer: Omit<AnalyzerDescription, "name" | "features">;
+        numHashes: number;
+    };
+};
+/**
+ * (Enterprise Edition only.) An object describing a Classification Analyzer
+ */
+export declare type ClassificationAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "classification";
+    properties: {
+        model_location: string;
+        top_k: number;
+        threshold: number;
+    };
+};
+/**
+ * (Enterprise Edition only.) An object describing a NearestNeighbors Analyzer
+ */
+export declare type NearestNeighborsAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "nearest_neighbors";
+    properties: {
+        model_location: string;
+        top_k: number;
+    };
+};
+/**
+ * An object describing a GeoJSON Analyzer
+ */
+export declare type GeoJsonAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "geojson";
+    properties: {
+        type: "shape" | "centroid" | "point";
+        description: {
+            maxCells: number;
+            minLevel: number;
+            maxLevel: number;
+        };
+    };
+};
+/**
+ * An object describing a GeoPoint Analyzer
+ */
+export declare type GeoPointAnalyzerDescription = GenericAnalyzerDescription & {
+    type: "geopoint";
+    properties: {
+        latitude: string[];
+        longitude: string[];
+        description: {
+            minCells: number;
+            minLevel: number;
+            maxLevel: number;
+        };
+    };
 };
 /**
- * Represents an Analyzer in a {@link Database}.
+ * Represents an Analyzer in a {@link database.Database}.
  */
 export declare class Analyzer {
     protected _name: string;
     protected _db: Database;
     /**
      * @internal
-     * @hidden
      */
     constructor(db: Database, name: string);
     /**
@@ -475,7 +753,7 @@ export declare class Analyzer {
     /**
      * Name of this Analyzer.
      *
-     * See also {@link Database.analyzer}.
+     * See also {@link database.Database}.
      */
     get name(): string;
     /**
@@ -501,11 +779,11 @@ export declare class Analyzer {
      * // definition contains the Analyzer definition
      * ```
      */
-    get(): Promise<ArangoResponseMetadata & AnalyzerDescription>;
+    get(): Promise<ArangoApiResponse<AnalyzerDescription>>;
     /**
      * Creates a new Analyzer with the given `options` and the instance's name.
      *
-     * See also {@link Database.createAnalyzer}.
+     * See also {@link database.Database#createAnalyzer}.
      *
      * @param options - Options for creating the Analyzer.
      *
@@ -517,7 +795,7 @@ export declare class Analyzer {
      * // the identity Analyzer "potatoes" now exists
      * ```
      */
-    create(options: CreateAnalyzerOptions): Promise<AnalyzerDescription>;
+    create<Options extends CreateAnalyzerOptions>(options: Options): Promise<Options extends CreateIdentityAnalyzerOptions ? IdentityAnalyzerDescription : Options extends CreateDelimiterAnalyzerOptions ? DelimiterAnalyzerDescription : Options extends CreateStemAnalyzerOptions ? StemAnalyzerDescription : Options extends CreateNormAnalyzerOptions ? NormAnalyzerDescription : Options extends CreateNgramAnalyzerOptions ? NgramAnalyzerDescription : Options extends CreateTextAnalyzerOptions ? TextAnalyzerDescription : Options extends CreateSegmentationAnalyzerOptions ? SegmentationAnalyzerDescription : Options extends CreateAqlAnalyzerOptions ? AqlAnalyzerDescription : Options extends CreatePipelineAnalyzerOptions ? PipelineAnalyzerDescription : Options extends CreateStopwordsAnalyzerOptions ? StopwordsAnalyzerDescription : Options extends CreateCollationAnalyzerOptions ? CollationAnalyzerDescription : Options extends CreateMinHashAnalyzerOptions ? MinHashAnalyzerDescription : Options extends CreateClassificationAnalyzerOptions ? ClassificationAnalyzerDescription : Options extends CreateNearestNeighborsAnalyzerOptions ? NearestNeighborsAnalyzerDescription : Options extends CreateGeoJsonAnalyzerOptions ? GeoJsonAnalyzerDescription : Options extends CreateGeoPointAnalyzerOptions ? GeoPointAnalyzerDescription : AnalyzerDescription>;
     /**
      * Deletes the Analyzer from the database.
      *
@@ -532,8 +810,8 @@ export declare class Analyzer {
      * // the Analyzer "some-analyzer" no longer exists
      * ```
      */
-    drop(force?: boolean): Promise<ArangoResponseMetadata & {
+    drop(force?: boolean): Promise<ArangoApiResponse<{
         name: string;
-    }>;
+    }>>;
 }
 //# sourceMappingURL=analyzer.d.ts.map