Object
Summary
The document outlines the attributes required for the context of an action, including name, type, and optional attributes. It also describes how to enable AI-driven semantic search on objects, which involves adding additional predefined attributes such as ObjectID and Description to the object's JSON formatted attributes. An example object definition for enabling semantic search is provided.
This object should contain the information of the context under which an action is being performed by a user. Context should contain the following attributes in a JSON formatted object.
Attribute Name | Description | Type | Required |
Name | Name of the object. This can include the definitions of the objects used by the application | String | Yes |
Type | Client defined type of the Object. | String | Yes |
Attributes | JSON formatted object properties | JSON | No |
Qualetics offers AI models for different scenarios. For websites that deal with products and content, a search feature is vital to provide the most relevant information to users.
Semantic Search uses natural language processing to provide results based on the meaning of a user's query instead of relying solely on keywords. For example, a query for "hdtv models with high resolution" would return results for TVs with 1080p or 4K resolutions.
In order to enable such functionality on your objects, a few additional steps are required while declaring your them. Specifically, a few key predefined attributes need to be added to the "attributes" section. The additional attributes and their data types are -
- ObjectID - String
- Description - String
- IndexForSearch - Boolean
Object Definition (For Semantic Search)
Attribute Name | Description | Type | Required |
Name | Name of the object. This can include the definitions of the objects used by the application | String | Yes |
Type | Client defined type of the Object. | String | Yes |
Attributes |
| JSON | Yes |
Example Object Definition for Enabling Semantic Search
