Multimodal search

A multi modal search is any combination of search modalities. All search modalities can be combined in an arbitrary way. It is possible to start a multi modal search with a single call of performSearch. Here is an example:

Partium.search.performSearch(
  {
    organizationName: 'Partium',
    searchLanguage: 'en',
    text: 'EX3',
    searchImage: new JsPFile( imageBlob ),
    searchImageCropArea: { x1: 0.1, y1: 0.2, x2: 0.5, y2: 0.8 },
    hierarchyFilters: [ '1ec55a3b-2408-4ed8-8e83-c3a88d0e7b86', '19f8a7e3-a3b5-450d-bd1f-14114bf53cd7' ],
    attributeFilters: {
      [ 'Category' ]: [ 'Fan', 'Connector' ],
      [ 'Voltage' ]: [ '20V' ],
    },
  }
)

The more common use case in a normal user flow is that one search modality is added after another. The user might start with an image search and later add text search and then filter search.

During a users search session with multiple search interactions, it is necessary to always send all search inputs, not just the ones that changed. For example if a user starts with a text search and later adds an attribute filter, the text search query needs to be sent along with the second request also:

let searchSessionId = null;

// Search interaction 1 - user starts text search
Partium.search.performSearch(
  {
    organizationName: 'Partium',
    searchLanguage: 'en',
    text: 'EX3',
  }
).subscribe((searchOutput: SearchOutput) => {
  searchSessionId = searchOutput.searchInput.searchSessionId;
});

...

// Search interaction 2 - user adds an attribute filter to the search session
Partium.search.performSearch(
  {
    organizationName: 'Partium',
    searchLanguage: 'en',
    searchSessionId: searchSessionId,
    text: 'EX3',
    attributeFilters: {
      [ 'Voltage' ]: [ '20V' ],
    },
  }
).subscribe((searchOutput: SearchOutput) => {
  searchSessionId = searchOutput.searchInput.searchSessionId;
});

Have a look here for more information about search sessions and a more complex example.