Interface Collections

interface Collections {
    create<TProperties, TName>(config): Promise<Collection<TProperties, TName>>;
    createFromSchema(config): Promise<Collection<Properties, string>>;
    delete(collection): Promise<void>;
    deleteAll(): Promise<void[]>;
    exists(name): Promise<boolean>;
    export(name): Promise<CollectionConfig>;
    get<TProperties, TName>(name): Collection<TProperties, TName>;
    listAll(): Promise<CollectionConfig[]>;
}

Methods

create createFromSchema delete deleteAll exists export get listAll

Methods

create

createFromSchema

  • createFromSchema(config): Promise<Collection<Properties, string>>

  • Parameters

    • config: {
          class?: string;
          description?: string;
          invertedIndexConfig?: {
              bm25?: {
                  b?: number;
                  k1?: number;
              };
              cleanupIntervalSeconds?: number;
              indexNullState?: boolean;
              indexPropertyLength?: boolean;
              indexTimestamps?: boolean;
              stopwords?: {
                  additions?: string[];
                  preset?: string;
                  removals?: string[];
              };
          };
          moduleConfig?: {
              [key: string]: unknown;
          };
          multiTenancyConfig?: {
              autoTenantActivation?: boolean;
              autoTenantCreation?: boolean;
              enabled?: boolean;
          };
          properties?: {
              dataType?: string[];
              description?: string;
              indexFilterable?: boolean;
              indexInverted?: boolean;
              indexRangeFilters?: boolean;
              indexSearchable?: boolean;
              moduleConfig?: {
                  [key: string]: unknown;
              };
              name?: string;
              nestedProperties?: {
                  dataType?: string[];
                  description?: string;
                  indexFilterable?: boolean;
                  indexRangeFilters?: boolean;
                  indexSearchable?: boolean;
                  name?: string;
                  nestedProperties?: { dataType?: string[] | undefined; description?: string | undefined; name?: string | undefined; indexFilterable?: boolean | undefined; indexSearchable?: boolean | undefined; indexRangeFilters?: boolean | undefined; tokenization?: "word" | ... 7 more ... | undefined; nestedProperties?: ...[] | undefined; }[] | undefi...;
                  tokenization?: "word" | "lowercase" | "whitespace" | "field" | "trigram" | "gse" | "kagome_kr" | "kagome_ja";
              }[];
              tokenization?: "word" | "lowercase" | "whitespace" | "field" | "trigram" | "gse" | "kagome_kr" | "kagome_ja";
          }[];
          replicationConfig?: {
              asyncEnabled?: boolean;
              deletionStrategy?: "NoAutomatedResolution" | "DeleteOnConflict" | "TimeBasedResolution";
              factor?: number;
          };
          shardingConfig?: {
              [key: string]: unknown;
          };
          vectorConfig?: {
              [key: string]: definitions["VectorConfig"];
          };
          vectorIndexConfig?: {
              [key: string]: unknown;
          };
          vectorIndexType?: string;
          vectorizer?: string;
      }
      • Optional class?: string

        Description

        Name of the class (a.k.a. 'collection') (required). Multiple words should be concatenated in CamelCase, e.g. ArticleAuthor.

      • Optional description?: string

        Description

        Description of the collection for metadata purposes.

      • Optional invertedIndexConfig?: {
            bm25?: {
                b?: number;
                k1?: number;
            };
            cleanupIntervalSeconds?: number;
            indexNullState?: boolean;
            indexPropertyLength?: boolean;
            indexTimestamps?: boolean;
            stopwords?: {
                additions?: string[];
                preset?: string;
                removals?: string[];
            };
        }
        • Optional bm25?: {
              b?: number;
              k1?: number;
          }
          • Optional b?: number

            Format: float

            Description

            Calibrates term-weight scaling based on the document length (default: 0.75).

          • Optional k1?: number

            Format: float

            Description

            Calibrates term-weight scaling based on the term frequency within a document (default: 1.2).

        • Optional cleanupIntervalSeconds?: number

          Format: int

          Description

          Asynchronous index clean up happens every n seconds

        • Optional indexNullState?: boolean

          Description

          Index each object with the null state (default: 'false').

        • Optional indexPropertyLength?: boolean

          Description

          Index length of properties (default: 'false').

        • Optional indexTimestamps?: boolean

          Description

          Index each object by its internal timestamps (default: 'false').

        • Optional stopwords?: {
              additions?: string[];
              preset?: string;
              removals?: string[];
          }
          • Optional additions?: string[]

            Description

            Stopwords to be considered additionally (default: []). Can be any array of custom strings.

          • Optional preset?: string

            Description

            Pre-existing list of common words by language (default: 'en'). Options: ['en', 'none'].

          • Optional removals?: string[]

            Description

            Stopwords to be removed from consideration (default: []). Can be any array of custom strings.

      • Optional moduleConfig?: {
            [key: string]: unknown;
        }

        Description

        Configuration specific to modules in a collection context.

        • [key: string]: unknown
      • Optional multiTenancyConfig?: {
            autoTenantActivation?: boolean;
            autoTenantCreation?: boolean;
            enabled?: boolean;
        }
        • Optional autoTenantActivation?: boolean

          Description

          Existing tenants should (not) be turned HOT implicitly when they are accessed and in another activity status (default: false).

        • Optional autoTenantCreation?: boolean

          Description

          Nonexistent tenants should (not) be created implicitly (default: false).

        • Optional enabled?: boolean

          Description

          Whether or not multi-tenancy is enabled for this class (default: false).

      • Optional properties?: {
            dataType?: string[];
            description?: string;
            indexFilterable?: boolean;
            indexInverted?: boolean;
            indexRangeFilters?: boolean;
            indexSearchable?: boolean;
            moduleConfig?: {
                [key: string]: unknown;
            };
            name?: string;
            nestedProperties?: {
                dataType?: string[];
                description?: string;
                indexFilterable?: boolean;
                indexRangeFilters?: boolean;
                indexSearchable?: boolean;
                name?: string;
                nestedProperties?: { dataType?: string[] | undefined; description?: string | undefined; name?: string | undefined; indexFilterable?: boolean | undefined; indexSearchable?: boolean | undefined; indexRangeFilters?: boolean | undefined; tokenization?: "word" | ... 7 more ... | undefined; nestedProperties?: ...[] | undefined; }[] | undefi...;
                tokenization?: "word" | "lowercase" | "whitespace" | "field" | "trigram" | "gse" | "kagome_kr" | "kagome_ja";
            }[];
            tokenization?: "word" | "lowercase" | "whitespace" | "field" | "trigram" | "gse" | "kagome_kr" | "kagome_ja";
        }[]

        Description

        Define properties of the collection.

      • Optional replicationConfig?: {
            asyncEnabled?: boolean;
            deletionStrategy?: "NoAutomatedResolution" | "DeleteOnConflict" | "TimeBasedResolution";
            factor?: number;
        }
        • Optional asyncEnabled?: boolean

          Description

          Enable asynchronous replication (default: false).

        • Optional deletionStrategy?: "NoAutomatedResolution" | "DeleteOnConflict" | "TimeBasedResolution"

          Description

          Conflict resolution strategy for deleted objects.

        • Optional factor?: number

          Description

          Number of times a class is replicated (default: 1).

      • Optional shardingConfig?: {
            [key: string]: unknown;
        }

        Description

        Manage how the index should be sharded and distributed in the cluster

        • [key: string]: unknown
      • Optional vectorConfig?: {
            [key: string]: definitions["VectorConfig"];
        }

        Description

        Configure named vectors. Either use this field or vectorizer, vectorIndexType, and vectorIndexConfig fields. Available from v1.24.0.

        • [key: string]: definitions["VectorConfig"]
      • Optional vectorIndexConfig?: {
            [key: string]: unknown;
        }

        Description

        Vector-index config, that is specific to the type of index selected in vectorIndexType

        • [key: string]: unknown
      • Optional vectorIndexType?: string

        Description

        Name of the vector index to use, eg. (HNSW)

      • Optional vectorizer?: string

        Description

        Specify how the vectors for this class should be determined. The options are either 'none' - this means you have to import a vector with each object yourself - or the name of a module that provides vectorization capabilities, such as 'text2vec-contextionary'. If left empty, it will use the globally configured default which can itself either be 'none' or a specific module.

    Returns Promise<Collection<Properties, string>>

delete

deleteAll

exists

export

get

listAll

Settings

Member Visibility

Theme

On This Page

createcreateFromSchemadeletedeleteAllexistsexportgetlistAll