weaviate-client
    Preparing search index...

    Type Alias RefPropertyDefault

    type RefPropertyDefault = {
        includeVector?: boolean | string[];
        linkOn: string;
        returnMetadata?: QueryMetadata;
        returnProperties?: (string | QueryNestedDefault)[];
        returnReferences?: RefPropertyDefault[];
        targetCollection?: string;
    }
    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: string

    The property to link on when defining the references traversal.

    returnMetadata?: QueryMetadata

    The metadata to return for the referenced objects.

    returnProperties?: (string | QueryNestedDefault)[]

    The properties to return for the referenced objects.

    returnReferences?: RefPropertyDefault[]

    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