weaviate-client/dist/node/esm/collections/types/query.d.ts

JS/TS client for Weaviate

import { WeaviateField } from '../index.js';
import { PrimitiveVectorType } from '../query/types.js';
import { CrossReferenceDefault } from '../references/index.js';
import { ExtractCrossReferenceType, NonRefKeys, QueryNestedDefault, QueryProperty, QueryReference, RefKeys } from './internal.js';
export type Metadata = {
    creationTime: Date;
    updateTime: Date;
    distance: number;
    certainty: number;
    score: number;
    explainScore: string;
    rerankScore: number;
    isConsistent: boolean;
};
export type MetadataKeys = (keyof Metadata)[];
export type QueryMetadata = 'all' | MetadataKeys | undefined;
export type ReturnMetadata = Partial<Metadata>;
export type WeaviateGenericObject<T, V> = {
    /** The generic returned properties of the object derived from the type `T`. */
    properties: ReturnProperties<T>;
    /** The returned metadata of the object. */
    metadata: ReturnMetadata | undefined;
    /** The returned references of the object derived from the type `T`. */
    references: ReturnReferences<T> | undefined;
    /** The UUID of the object. */
    uuid: string;
    /** The returned vectors of the object. */
    vectors: V;
};
export type WeaviateNonGenericObject = {
    /** The returned properties of the object. */
    properties: Record<string, WeaviateField>;
    /** The returned metadata of the object. */
    metadata: ReturnMetadata | undefined;
    /** The returned references of the object. */
    references: Record<string, CrossReferenceDefault> | undefined;
    /** The UUID of the object. */
    uuid: string;
    /** The returned vectors of the object. */
    vectors: Vectors;
};
export type ReturnProperties<T> = Pick<T, NonRefKeys<T>>;
export type ReturnReferences<T> = Pick<T, RefKeys<T>>;
export interface Vectors {
    [k: string]: PrimitiveVectorType;
}
export type ReturnVectors<V, I> = V extends undefined ? undefined : I extends true ? V : I extends Array<infer U> ? Pick<V, {
    [Key in keyof V]: Key extends U ? Key : never;
}[keyof V]> : never;
/** An object belonging to a collection as returned by the methods in the `collection.query` namespace.
 *
 * Depending on the generic type `T`, the object will have subfields that map from `T`'s specific type definition.
 * If not, then the object will be non-generic and have a `properties` field that maps from a generic string to a `WeaviateField`.
 */
export type WeaviateObject<T, V> = T extends undefined ? V extends undefined ? WeaviateNonGenericObject : WeaviateGenericObject<WeaviateNonGenericObject['properties'], V> : V extends undefined ? WeaviateGenericObject<T, WeaviateNonGenericObject['vectors']> : WeaviateGenericObject<T, V>;
/** The return of a query method in the `collection.query` namespace. */
export type WeaviateReturn<T, V> = {
    /** The objects that were found by the query. */
    objects: WeaviateObject<T, V>[];
};
export type GroupByObject<T, V> = WeaviateObject<T, V> & {
    belongsToGroup: string;
};
export type GroupByResult<T, V> = {
    name: string;
    minDistance: number;
    maxDistance: number;
    numberOfObjects: number;
    objects: WeaviateObject<T, V>[];
};
/** The return of a query method in the `collection.query` namespace where the `groupBy` argument was specified. */
export type GroupByReturn<T, V> = {
    /** The objects that were found by the query. */
    objects: GroupByObject<T, V>[];
    /** The groups that were created by the query. */
    groups: Record<string, GroupByResult<T, V>>;
};
export type GroupByOptions<T> = T extends undefined ? {
    property: string;
    numberOfGroups: number;
    objectsPerGroup: number;
} : {
    property: keyof T;
    numberOfGroups: number;
    objectsPerGroup: number;
};
export type RerankOptions<T> = T extends undefined ? {
    property: string;
    query: string;
} : {
    property: keyof T;
    query?: string;
};
export interface BaseRefProperty<T> {
    /** The property to link on when defining the references traversal. */
    linkOn: RefKeys<T>;
    /** Whether to return the vector(s) of the referenced objects in the query. */
    includeVector?: boolean | string[];
    /** The metadata to return for the referenced objects. */
    returnMetadata?: QueryMetadata;
    /** The properties to return for the referenced objects. */
    returnProperties?: QueryProperty<ExtractCrossReferenceType<T[this['linkOn']]>>[];
    /** The references to return for the referenced objects. */
    returnReferences?: QueryReference<ExtractCrossReferenceType<T[this['linkOn']]>>[];
    /** The collection to target when traversing the references. Required for multi-target references. */
    targetCollection?: string;
}
export type RefProperty<T> = BaseRefProperty<T>;
export type RefPropertyDefault = {
    /** The property to link on when defining the references traversal. */
    linkOn: string;
    /** Whether to return the vector(s) of the referenced objects in the query. */
    includeVector?: boolean | string[];
    /** The metadata to return for the referenced objects. */
    returnMetadata?: QueryMetadata;
    /** The properties to return for the referenced objects. */
    returnProperties?: (string | QueryNestedDefault)[];
    /** The references to return for the referenced objects. */
    returnReferences?: RefPropertyDefault[];
    /** The collection to target when traversing the references. Required for multi-target references. */
    targetCollection?: string;
};
export type SortBy = {
    property: string;
    ascending?: boolean;
};