Aller au contenu principal
Version : 21 BETA

$filter

Permet de rechercher les données d'une dataclass ou d'une méthode (par exemple, $filter="firstName!='' AND salary>30000")

Description​

Ce paramètre vous permet de définir le filtre de votre dataclass ou de votre méthode.

Utiliser un filtre simple​

Un filtre est composé des éléments suivants :

{attribute} {comparator} {value}

Par exemple : $filter="firstName=john" où firstName est l'attribut, = est le comparateur et john est la valeur.

Utiliser un filtre complexe​

Un filtre plus complexe est composé des éléments suivants, qui joint deux requêtes:

{attribute} {comparator} {value} {AND/OR/EXCEPT} {attribute} {comparator} {value}

Par exemple : $filter="firstName=john AND salary>20000" où firstName et salary sont les attributs de la dataclass "Employee".

Utiliser la propriété params​

You can also use 4D's params property which is a collection of values.

{attribute} {comparator} {placeholder} {AND/OR/EXCEPT} {attribute} {comparator} {placeholder}&$params='["{value1}","{value2}"]'

Par exemple : $filter="firstName=:1 AND salary>:2"&$params='["john",20000]'" où firstName et salary sont les attributs de la dataclass "Employee".

Pour plus d'informations sur la façon de rechercher des données dans 4D, reportez-vous à la documentation de dataClass.query().

Lorsque vous insérez des guillemets (') ou des guillemets doubles ("), vous devez les échapper en utilisant leur code de caractère :

  • Quotes ('): \u0027
  • Guillemets doubles ("): \u0022

    • Par exemple, vous pouvez écrire ce qui suit lors du passage d'une valeur avec un guillemet lors de l'utilisation de la propriété params :
    http://127.0.0.1:8081/rest/Person/?$filter="lastName=:1"&$params='["O\u0027Reilly"]'

    Si vous passez la valeur directement, vous pouvez écrire ce qui suit: http://127.0.0.1:8081/rest/Person/?$filter="lastName=O'Reilly"

    Attribut​

    Si l'attribut se trouve dans la même dataclass, vous pouvez simplement le passer directement (par exemple, firstName). Cependant, si vous souhaitez lancer une requête dans une autre dataclass, vous devez inclure le nom de l'attribut relationnel et le nom d'attribut, c'est-à-dire le chemin d'accès (par exemple, employeur.nom). Le nom d'attribut est sensible à la casse (firstName n'est pas égal à FirstName).

    Vous pouvez également rechercher des attributs de type Objet en utilisant la notation par points. Par exemple, si vous avez un attribut dont le nom est "objAttribute" avec la structure suivante :

    {
        prop1: "this is my first property",
        prop2: 9181,
        prop3: ["abc","def","ghi"]
    }

    Vous pouvez rechercher dans l'objet en écrivant ce qui suit :

    GET /rest/Person/?filter="objAttribute.prop2 == 9181"

    Comparateur​

    Le comparateur doit être l'une des valeurs suivantes :

    ComparateurDescription
    =est égal à
    !=différent de
    >supérieur à
    > =supérieur ou égal à
    <inférieur à
    <=inférieur ou égal à
    begincommence avec

    Vector similarity​

    If the attribute stores vector objects (see how to configure a 4D field to only store 4D.Vector class objects), you can filter the dataclass using vectors, aka embeddings.

    For more information about vector similarity searches, please refer to Query by vector similarity section.

    Use the params property to provide the filter with the vector comparison parameter, using a syntax like:

    {vectorAttribute} {comparator} {placeholder}&$params=vectorComparison

    The vectorComparison parameter is a collection of the following elements:

    PropriétéTypeDescription
    [].vectorCollection d'objets)Obligatoire. A collection that represents the vector to compare
    [].metricTextOptionnel. Calcul vectoriel à utiliser pour la recherche. Supported values:
  • "cosine" (default if omitted): calculates the cosine distance between vectors.
  • "dot": calculates the dot similarity of vectors.
  • "euclidean": calculates the Euclidean distance between vectors.
    • [].thresholdRealFacultatif (valeur par défaut : 0,5). Valeur seuil utilisée pour filtrer les comparaisons de vecteurs sur la base de leur score de similarité cosinus, point ou euclidienne selon la "métrique" sélectionnée. Il est fortement recommandé de choisir une similitude qui corresponde le mieux à votre cas d'utilisation spécifique pour des résultats optimaux.

    Only a subset of comparator symbols are supported with vector comparisons. Notez qu'ils comparent les résultats à la valeur de seuil (threshold) :

    ComparateurSymbole(s)Commentaire
    Inférieur à<Inférieur au seuil
    Supérieur à>Supérieur au seuil
    Inférieur ou égal à<=Inférieur ou égal au seuil
    Supérieur ou égal à> =Supérieur ou égal au seuil

    Exemples​

    Dans l'exemple suivant, nous recherchons tous les employés dont le nom de famille commence par un "j" :

     GET  /rest/Employee?$filter="lastName begin j"

    Dans cet exemple, nous recherchons dans la dataclass "Employee" tous les employés d'une entreprise autre que Acmedont et dont le salaire est supérieur à 20 000 :

     GET  /rest/Employee?$filter="salary>20000 AND  
     employer.name!=acme"&$orderby="lastName,firstName"

    Dans cet exemple, nous recherchons dans la dataclass "Person" toutes les personnes dont la propriété numérique, de l'attribut anotherobj de type Objet, est supérieure à 50 :

     GET  /rest/Person/?filter="anotherobj.mynum > 50"

    In this example, we do a vector search with basic values:

     GET  /rest/Person/?filter="VectorAtt>=:1"&$params='[{vector:[1,2,3],threshold:1}]'