The Search App allows you to find similar items in your data set either using an item already present in that data set (similarity search) or an ad-hoc item (semantic search) and can be used for text and images. This guide is for text searches, to review details of image (visual) search please see here.
Also please review our Search Quick start video
Pre requisite
You will need to have created a project to build your search app in.
App Selection
- Select the App type you would like to create from the App Library template tab
- Mousing over the App tile will display a short description of the App and its applications
Select which of the methods you would like to create the App if you have your own data ready to go
Alternatively use the Graft Demo data source
App Configuration
|
Samples will be shown below the selections allowing you to validate you have made the correct selections
|
|
|
|
|
Graft will now process a sample of your data, typically 100 items and upon completion will show the App TRY IT tab.
TRY IT
The TRY IT tab allows you to experiment with your new app without the need for any coding skills and allows you to test the configuration, filter results and if necessary adjust the app configuration.
Rerank passes the search results through a ranking model to generate relevance scores please see the Reranking guide for more details.
Search Variant allows the user to select how Graft should search your data see Search Variants for more information.
|
The right hand panel shows the current configuration, the name of the entity which holds your app data, the field we are searching and information about the current data set.
|
Ensure you Sync your data to fully evaluate the App's performance against all of your data.
Adhoc - search
The ADHOC sub tab within TRY IT allows you to query your new app with text that is not within your data set.
For example using our demo product catalog you could add in a short description of a item and see what is returned from the catalog.
Add in the text you wish to search for in the Search bar and hit return or click SEARCH and sample results (up to 10) will be displayed.
Search in Data Set
The SEARCH IN DATASET sub tab within TRY IT allows you to use an known example and find similar items within your data set.
Graft provides you with a window where you can scroll through the current data set (100 in our example image above) and find a suitable entry you wish to use. Click on FIND SIMILAR and Graft will present the nearest matches.
To help narrow down your search for a suitable search item you can enter text in the filter bar and Click FILTER.
To clear the current filter, click on the X at the enter of the filter bar.
Scrolling through the results you can make your selection, Click on FIND SIMILAR to see your results.
To clear the current results click on the UNSELECT button in the select panel
Filtering Results
Results can be displayed in table (default)
tiled, and
gallery views, click any button to change format.
Once your query results are displayed you are able to adjust filters ,
,
to refine the results, see View Results & Filtering for more details
API tab
This tab allows you to experiment with an API snippet which can then be copied and used in your own development environment
You will need an API key to start. If none are available Click on the Create an API key link and follow these instructions. If there are one or more API keys in the project you can switch between then using the API key drop down menu. Click on MANAGE KEYS to add or delete new keys.
The API snippet is controlled from the configuration bar on the right.
|
Changes made to the configuration are immediately shown in the code. Use the Output format drop down to switch between CSV (default), TSV or JSONL (JSON Lines) formats
The ENTITY COLUMNS drop down allows you to add or remove columns from the output
ENTITY KNN_ADHOC dropdown shows the current search query to be run, the default text is "query text" replace this with the text you would like to search for or a URI to an image for visual search
ENTITY KNN_K allows you to control the number of items returned in your results, default value is 10
RERANK allows your similarity search results to be reranked by Relevance using the Graft ranking model
VARIANT Select the search variant for the API call
|
|
|
|
|
Once you have added in a query click on TEST REQUEST to run the API query.
The results are displayed in the response tile below.
Copying the Request Code
Click on the icon to the right of the REQUEST heading in the top left hand corner of the code window
Copying the response
Click on the icon to the right of the RESPONSE heading in the top left hand corner of the results window
Optimize tab
This tab allows you to experiment with different models available in Graft in your App. You can compare the performance of selected models vs your current model and swap as needed. Further details on Optimization can be found here.
Settings tab
| This tab allows you manage the settings for your new Search App. |
Renaming your App instance
|
To rename your App click on the current name hyperlink.
Type in your new name
Click |
Editing your configuration
| Clicking on the |
Deleting your App
If you would like to delete your app, this is done from your App library
For any changes made to your settings ensure that you click SAVE to confirm your changes.
App API limits
The number of Apps available for external access is limited by your tier. If no APIs are remaining you will need to disable any existing APIs (save the changes) and then enable the App API of interest or consider upgrading to a bigger tier.