Smart filters

Smart Filters assist users in quickly locating the correct part by suggesting the most relevant filters suitable for the current search. These filters are presented to the user as selectable values, which can be used in subsequent search attempts.

Please see this article to learn how Smart Filters work and the value they bring to users.

The Smart Filters are associated with each search attempt and are available in the smartFilters field for every search response. Remember to specify "projection": [..., "smartFilters"] in order to enable the feature.

---

HTTP

> POST https://api.partium.io/1/find/search
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
> Content-Length: 169
>
> {
>   "language": "en",
>   "projection": ["results.id", "smartFilters"],
>   "matches": {
>     "organization": "<<Your Organization Name>>",
>     "text": "fuse cartridge"
>   }
> }
>
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 702
<
< {
<   "sessionId": "cfaac7fc-8c0a-420a-b6ee-f59396861753",
<   "imageId": null,
<   "results": [
<     {
<       "id": "PM19239.AB"
<     },
<     {
<       "id": "PM19241.AD"
<     },
<     {
<       "id": "PM19239.AF"
<     }
<   ],
<   "smartFilters": [
<     {
<       "label": "Voltage",
<       "values": [
<         {
<           "value": "220V",
<           "count": 1
<         },
<         {
<           "value": "127V",
<           "count": 2
<         }
<       ]
<     },
<     {
<       "label": "Amperage",
<       "values": [
<         {
<           "value": "10A",
<           "count": 1
<         },
<         {
<           "value": "2A",
<           "count": 1
<         },
<         {
<           "value": "4A",
<           "count": 1
<         }
<       ]
<     }
<   ]
< }

...

> POST https://api.k8s.int.partium.io/1/find/search
> Authorization: Bearer <<Your Access Token or API Key>>
> Content-Type: application/json
> Content-Length: 337
>
> {
>   "language": "en",
>   "projection": ["results.id", "smartFilters"],
>   "matches": {
>     "organization": "<<Your Organization Name>>",
>     "text": "fuse cartridge",
>     "filters": [
>       {
>         "label": "Voltage",
>         "values": ["127V"]
>       },
>       {
>         "label": "Amperage",
>         "values": ["10A"]
>       }
>     ]
>   }
> }
>
< HTTP/1.1 200 OK
< Content-Type: application/json
< Content-Length: 155
<
< {
<   "sessionId": "cfaac7fc-8c0a-420a-b6ee-f59396861753",
<   "imageId": null,
<   "results": [
<     {
<       "id": "PM19241.AD"
<     }
<   ],
<   "smartFilters": []
< }

Python

response = requests.post(
  'https://api.partium.io/1/find/search',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json={
    'language': 'en',
    'projection': ['results.id', 'smartFilters'],
    'matches': {
      'organization': '<<Your Organization Name>>',
      'text': 'fuse cartridge'
    },
  },
)
response_body = response.json()
filters = response_body['smartFilters']

...

response = requests.post(
  'https://api.partium.io/1/find/search',
  headers={
    'Authorization': 'Bearer <<Your Access Token or API Key>>',
  },
  json={
    'language': 'en',
    'projection': ['results.id', 'smartFilters'],
    'matches': {
      'organization': '<<Your Organization Name>>',
      'text': 'fuse cartridge',
      'filters': [{'label': f.label, 'values': f.values} for f in selected_filter_values}],
    },
  },
)
...

JavaScript

let filters = null;
fetch('https://api.partium.io/1/find/search', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: {
    language: 'en',
    projection: ['results.id', 'smartFilters'],
    matches: {
      organization: '<<Your Organization Name>>',
      text: 'fuse cartridge',
    },
  },
}).then(response => response.json())
.then(data => {
  filters = data.smartFilters;
});

...

fetch('https://api.partium.io/1/find/search', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <<Your Access Token or API Key>>',
  },
  body: {
    language: 'en',
    projection: ['results.id', 'smartFilters'],
    matches: {
      organization: '<<Your Organization Name>>',
      text: 'automatic dog feeder',
      filters: selected_filtes.map(f => ({label: f.name, values: f.selectedValues})),
    },
  },
}).then(response => response.json())
...

note

Replace <<Your Organization Name>> with the provided organization name.

Replace <<Your Access Token or API Key>> with the preferred authentication method. See Authentication.

---