weaviate-client
    Preparing search index...

    Interface BaseRefProperty<T>

    interface BaseRefProperty<T> {
        includeVector?: boolean | string[];
        linkOn: RefKeys<T>;
        returnMetadata?: QueryMetadata;
        returnProperties?: QueryProperty<ExtractCrossReferenceType<T[RefKeys<T>]>>[];
        returnReferences?: QueryReference<ExtractCrossReferenceType<T[RefKeys<T>]>>[];
        targetCollection?: string;
    }

    Type Parameters

    • T
    Index

    Properties

    includeVector? linkOn returnMetadata? returnProperties? returnReferences? targetCollection?

    Properties

    includeVector?: boolean | string[]

    Whether to return the vector(s) of the referenced objects in the query.

    linkOn: RefKeys<T>

    The property to link on when defining the references traversal.

    returnMetadata?: QueryMetadata

    The metadata to return for the referenced objects.

    returnProperties?: QueryProperty<ExtractCrossReferenceType<T[RefKeys<T>]>>[]

    The properties to return for the referenced objects.

    returnReferences?: QueryReference<ExtractCrossReferenceType<T[RefKeys<T>]>>[]

    The references to return for the referenced objects.

    targetCollection?: string

    The collection to target when traversing the references. Required for multi-target references.

    Settings

    Member Visibility

    On This Page

    Properties