Interface Collection<T, N, V>

interface Collection<T, N, V> {
    aggregate: Aggregate<T, V>;
    backup: BackupCollection;
    config: Config<T>;
    data: Data<T>;
    exists: (() => Promise<boolean>);
    filter: Filter<T extends undefined
        ? any
        : T>;
    generate: Generate<T, V>;
    iterator: (<I, RV>(opts?) => Iterator<T, RV>);
    length: (() => Promise<number>);
    metrics: Metrics<T>;
    multiTargetVector: MultiTargetVector<V>;
    name: N;
    query: Query<T, V>;
    sort: Sort<T>;
    tenants: Tenants;
    withConsistency: ((consistencyLevel) => Collection<T, N, V>);
    withTenant: (<TT>(tenant) => Collection<T, N, V>);
}

Type Parameters

  • T = undefined
  • N = string
  • V = undefined

Properties

aggregate backup config data exists filter generate iterator length metrics multiTargetVector name query sort tenants withConsistency withTenant

Properties

aggregate

aggregate: Aggregate<T, V>

This namespace includes all the querying methods available to you when using Weaviate's standard aggregation capabilities.

backup

backup: BackupCollection

This namespace includes all the backup methods available to you when backing up a collection in Weaviate.

config

config: Config<T>

This namespace includes all the CRUD methods available to you when modifying the configuration of the collection in Weaviate.

data

data: Data<T>

This namespace includes all the CUD methods available to you when modifying the data of the collection in Weaviate.

exists

exists: (() => Promise<boolean>)

Use this method to check if the collection exists in Weaviate.

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

Returns

A promise that resolves to true if the collection exists, and false otherwise.

filter

filter: Filter<T extends undefined
    ? any
    : T>

This namespace includes the methods by which you can create the FilterValue<V> values for use when filtering queries over your collection.

generate

generate: Generate<T, V>

This namespace includes all the querying methods available to you when using Weaviate's generative capabilities.

iterator

iterator: (<I, RV>(opts?) => Iterator<T, RV>)

Use this method to return an iterator over the objects in the collection.

This iterator keeps a record of the last object that it returned to be used in each subsequent call to Weaviate. Once the collection is exhausted, the iterator exits.

Type declaration

    • <I, RV>(opts?): Iterator<T, RV>

    • Type Parameters

      • I extends IncludeVector<V>

        The vector(s) to include in the response. If using named vectors, pass an array of strings to include only specific vectors.

      • RV

        The vectors(s) to be returned in the response depending on the input in opts.includeVector.

      Parameters

      • Optional opts: IteratorOptions<T, I>

        The options to use when fetching objects from Weaviate.

      Returns Iterator<T, RV>

Returns

An iterator over the objects in the collection as an async generator.

Description

If return_properties is not provided, all the properties of each object will be requested from Weaviate except for its vector as this is an expensive operation. Specify include_vector to request the vectors back as well. In addition, if return_references=None then none of the references are returned. Use wvc.QueryReference to specify which references to return.

length

length: (() => Promise<number>)

Use this method to return the total number of objects in the collection.

This is a short-hand for calling collection.aggregate.overAll().then(({ totalCount }) => totalCount).

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

metrics

metrics: Metrics<T>

This namespace includes the methods by which you can create the MetricsX values for use when aggregating over your collection.

multiTargetVector

multiTargetVector: MultiTargetVector<V>

This namespaces includes the methods by which you cna create the MultiTargetVectorJoin values for use when performing multi-target vector searches over your collection.

name

name: N

The name of the collection.

query

query: Query<T, V>

This namespace includes all the querying methods available to you when using Weaviate's standard query capabilities.

sort

sort: Sort<T>

This namespaces includes the methods by which you can create the Sorting<T> values for use when sorting queries over your collection.

tenants

tenants: Tenants

This namespace includes all the CRUD methods available to you when modifying the tenants of a multi-tenancy-enabled collection in Weaviate.

withConsistency

withConsistency: ((consistencyLevel) => Collection<T, N, V>)

Use this method to return a collection object specific to a single consistency level.

If replication is not configured for this collection then Weaviate will throw an error.

This method does not send a request to Weaviate. It only returns a new collection object that is specific to the consistency level you specify.

Type declaration

Returns

A new collection object specific to the consistency level you specified.

withTenant

withTenant: (<TT>(tenant) => Collection<T, N, V>)

Use this method to return a collection object specific to a single tenant.

If multi-tenancy is not configured for this collection then Weaviate will throw an error.

This method does not send a request to Weaviate. It only returns a new collection object that is specific to the tenant you specify.

Type declaration

Returns

A new collection object specific to the tenant you specified.

Settings

Member Visibility

Theme

On This Page

aggregatebackupconfigdataexistsfiltergenerateiteratorlengthmetricsmultiTargetVectornamequerysorttenantswithConsistencywithTenant