Interface WeaviateFilter

Interface that defines a filter for querying data from Weaviate. It includes a distance and a WhereFilter.

interface WeaviateFilter {
    distance?: number;
    where: {
        operands?: ({ operands?: ...[] | undefined; operator?: "And" | "Or" | "Equal" | "NotEqual" | "LessThan" | "LessThanEqual" | "GreaterThan" | "GreaterThanEqual" | "Like" | "WithinGeoRange" | "IsNull" | "ContainsAny" | "ContainsAll" | undefined; ... 13 more ...; valueGeoRange?: { ...; } | undefined; })[];
        operator?:
            | "And"
            | "Or"
            | "Equal"
            | "NotEqual"
            | "LessThan"
            | "LessThanEqual"
            | "GreaterThan"
            | "GreaterThanEqual"
            | "Like"
            | "WithinGeoRange"
            | "IsNull"
            | "ContainsAny"
            | "ContainsAll";
        path?: string[];
        valueBoolean?: boolean;
        valueBooleanArray?: boolean[];
        valueDate?: string;
        valueDateArray?: string[];
        valueGeoRange?: {
            distance?: {
                max?: number;
            };
            geoCoordinates?: {
                latitude?: number;
                longitude?: number;
            };
        };
        valueInt?: number;
        valueIntArray?: number[];
        valueNumber?: number;
        valueNumberArray?: number[];
        valueString?: string;
        valueStringArray?: string[];
        valueText?: string;
        valueTextArray?: string[];
    };
}

Properties

distance? where

Properties

Optionaldistance

distance?: number

where

where: {
    operands?: ({ operands?: ...[] | undefined; operator?: "And" | "Or" | "Equal" | "NotEqual" | "LessThan" | "LessThanEqual" | "GreaterThan" | "GreaterThanEqual" | "Like" | "WithinGeoRange" | "IsNull" | "ContainsAny" | "ContainsAll" | undefined; ... 13 more ...; valueGeoRange?: { ...; } | undefined; })[];
    operator?:
        | "And"
        | "Or"
        | "Equal"
        | "NotEqual"
        | "LessThan"
        | "LessThanEqual"
        | "GreaterThan"
        | "GreaterThanEqual"
        | "Like"
        | "WithinGeoRange"
        | "IsNull"
        | "ContainsAny"
        | "ContainsAll";
    path?: string[];
    valueBoolean?: boolean;
    valueBooleanArray?: boolean[];
    valueDate?: string;
    valueDateArray?: string[];
    valueGeoRange?: {
        distance?: {
            max?: number;
        };
        geoCoordinates?: {
            latitude?: number;
            longitude?: number;
        };
    };
    valueInt?: number;
    valueIntArray?: number[];
    valueNumber?: number;
    valueNumberArray?: number[];
    valueString?: string;
    valueStringArray?: string[];
    valueText?: string;
    valueTextArray?: string[];
}

Type declaration

  • Optionaloperands?: ({ operands?: ...[] | undefined; operator?: "And" | "Or" | "Equal" | "NotEqual" | "LessThan" | "LessThanEqual" | "GreaterThan" | "GreaterThanEqual" | "Like" | "WithinGeoRange" | "IsNull" | "ContainsAny" | "ContainsAll" | undefined; ... 13 more ...; valueGeoRange?: { ...; } | undefined; })[]

    Description

    combine multiple where filters, requires 'And' or 'Or' operator

  • Optionaloperator?:
        | "And"
        | "Or"
        | "Equal"
        | "NotEqual"
        | "LessThan"
        | "LessThanEqual"
        | "GreaterThan"
        | "GreaterThanEqual"
        | "Like"
        | "WithinGeoRange"
        | "IsNull"
        | "ContainsAny"
        | "ContainsAll"

    Description

    operator to use

    Example

    GreaterThanEqual
    @enum {string}
  • Optionalpath?: string[]

    Description

    path to the property currently being filtered

    Example

    [
      "inCity",
      "City",
      "name"
    ]
  • OptionalvalueBoolean?: boolean

    Description

    value as boolean

    Example

    false
  • OptionalvalueBooleanArray?: boolean[]

    Description

    value as boolean

    Example

    [
      true,
      false
    ]
  • OptionalvalueDate?: string

    Description

    value as date (as string)

    Example

    TODO
  • OptionalvalueDateArray?: string[]

    Description

    value as date (as string)

    Example

    TODO
  • OptionalvalueGeoRange?: {
        distance?: {
            max?: number;
        };
        geoCoordinates?: {
            latitude?: number;
            longitude?: number;
        };
    }

    Description

    value as geo coordinates and distance

    • Optionaldistance?: {
          max?: number;
      }
      • Optionalmax?: number

        Format: float64

    • OptionalgeoCoordinates?: {
          latitude?: number;
          longitude?: number;
      }
      • Optionallatitude?: number

        Format: float

        Description

        The latitude of the point on earth in decimal form

      • Optionallongitude?: number

        Format: float

        Description

        The longitude of the point on earth in decimal form

  • OptionalvalueInt?: number

    Format: int64

    Description

    value as integer

    Example

    2000
  • OptionalvalueIntArray?: number[]

    Description

    value as integer

    Example

    [100, 200]
  • OptionalvalueNumber?: number

    Format: float64

    Description

    value as number/float

    Example

    3.14
  • OptionalvalueNumberArray?: number[]

    Description

    value as number/float

    Example

    [
      3.14
    ]
  • OptionalvalueString?: string

    Description

    value as text (deprecated as of v1.19; alias for valueText)

    Example

    my search term
  • OptionalvalueStringArray?: string[]

    Description

    value as text (deprecated as of v1.19; alias for valueText)

    Example

    [
      "my search term"
    ]
  • OptionalvalueText?: string

    Description

    value as text

    Example

    my search term
  • OptionalvalueTextArray?: string[]

    Description

    value as text

    Example

    [
      "my search term"
    ]

Settings

Member Visibility

On This Page

Properties