Type alias SearchOptions<T>

SearchOptions<T>: {
    autoLimit?: number;
    filters?: FilterValue;
    includeVector?: boolean | string[];
    limit?: number;
    offset?: number;
    rerank?: RerankOptions<T>;
    returnMetadata?: QueryMetadata;
    returnProperties?: QueryProperty<T>[];
    returnReferences?: QueryReference<T>[];
}

Base options available to all the query methods that involve searching.

Type Parameters

  • T

Type declaration

  • Optional autoLimit?: number

    The autocut parameter

  • Optional filters?: FilterValue

    The filters to be applied to the query. Use weaviate.filter.* to create filters

  • Optional includeVector?: boolean | string[]

    Whether to include the vector of the object in the response. If using named vectors, pass an array of strings to include only specific vectors.

  • Optional limit?: number

    How many objects to return in the query

  • Optional offset?: number

    How many objects to skip in the query. Incompatible with the after cursor

  • Optional rerank?: RerankOptions<T>

    How to rerank the query results. Requires a configured reranking module.

  • Optional returnMetadata?: QueryMetadata

    Which metadata of the object to return. If not specified, no metadata is returned.

  • Optional returnProperties?: QueryProperty<T>[]

    Which properties of the object to return. Can be primitive, in which case specify their names, or nested, in which case use the QueryNested type. If not specified, all properties are returned.

  • Optional returnReferences?: QueryReference<T>[]

    Which references of the object to return. If not specified, no references are returned.

Settings

Member Visibility

Theme