Semantic search
Semantic search is used to find objects in the database by meaning rather than exact words. It searches a property that has semantic search enabled in the data model, and returns the objects whose values are most similar in meaning to the search term.
Usage
This action node can be used when users describe what they are looking for in their own words, and the matching objects may not contain the same words. An example can be a knowledge base where users ask a question and get the articles that answer it.
To match exact words, search as the user types, search several properties at once, or filter the results, use Full-text search instead.
The action node is available in apps and flows, not in Services.
See Configure semantic search for a step-by-step guide on how to set up semantic search in an app.
Properties
Data source
Select the data source you want to populate with the search results. Must be a runtime-only data source, an action data source, or an action variable.
Search score
Available when a Data source is selected. Every object returned by Semantic search is assigned a score from 0 to 1 based on similarity to the search term. Select a property on the selected Data source to store this score, for example to sort or filter on it later. Must be of type Float. Changing the Data source clears this selection.
Search field
Select the property to search in. Only String and Rich Text properties with Semantic search turned on in the data model are listed. User and file object classes can't be searched. Changing the Data source clears this selection.
Search term
Define the text to search for. This will typically be an app variable or action param containing the user's input. The search term can be at most 2000 characters long.
Limit result
Limit the maximum number of objects returned in the search. Default is 10, and the value must be between 1 and 1000. If the Data source has cardinality one, a single object is returned.
Search results
Each search replaces the contents of the selected Data source. The objects are sorted by similarity, with the most similar object first.
If the search term is empty, no objects are returned and the data source is cleared.
The search only returns objects the user has permission to read. A user without read access to the object class gets an empty result rather than an error.
Rich Text properties are searched by their text content. Formatting is not part of the search.
Index availability
The search index for a property is built separately in each environment, starting when the change is deployed there. Until the build has finished, the action node fails with one of these errors:
Semantic search index for '<node name>' has not been created yet - it is created on the next index syncSemantic search index for '<node name>' is not ready yet - embeddings are being prepared (status: <status>)
<node name> is the property's Node Name in the data model.
Last updated
Was this helpful?