The Search App allows you to find similar items in your data set either using an item already present in that data set or an ad-hoc item and can be used for text and images. This guide is for image searches, to review details of text search please see here.
Also please review our Visual Search Quick start video
- 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.
|
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
The ADHOC sub tab within TRY IT allows you to query your new app with an image that is not within your data set.
You can upload your test image in a number of ways...
- Clicking on the Upload Tile and selecting an image
- Drag an image into the tile allows you to test the newly created search app.
- Paste a URL into the Search bar and Click SEARCH
Results will be generated and displayed below.
Search in Data Set - Similarity Search
The SEARCH IN DATASET sub tab within TRY IT allows you to use an known example and find similar items within your data set.
If required use the FILTER bar to reduce your results
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
Search results are displayed in the center next to the target image.
Results can be displayed in tiled (default),
table 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 URI of an image
Entity_knn_k allows you to control the number of itemsreturned in your results, default value is 10
Each configuration item can be compressed by clicking on the |
Once you have added in a query (either text or image URI) click on TEST REQUEST to run the API query.
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 to delete your app, see which field is being processed for the App and also enable the App for external API access.
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.