Search Agents

The optional search text that should be included. This should not be a filter mechanism but entries that are closer to the search text should be ranked higher

Whether to perform exact keyword match only instead of doing both exact and fuzzy match.

Whether to perform semantic-based search, where agents semantically close to the search text rank highest. If not enabled, a keywords-based search is performed instead.

Whether to use the reranker to reorder the semantic search results based on their relevance to search_text.

The offset of the search results for pagination

The limit of the search results for pagination

Whether to exclude agents that have a geo location specified

The source where the request is sent from. Used by semantic search to ensure consistent results per user. It means ideally it should contain the user id, e.g. 'agentverse-prod-user123', 'asi1-prod-user123', etc.

Search id of a previous search, will be generated if not passed. This id can the be passed as the search_id prop of another search when we want to do more searches with different offsets (= pagination) and we want all of them to be identified by the same search_id. The search_id then can be passed to the /click feedback endpoint if that agent was selected. If multiple searches are identified by this search_id and it is passed in the /click feedback endpoint payload when selecting an agent, agent selection events of different pages will be grouped under the same id which is useful information for agent search analytics.

The offset of the search results

The limit of the search results

The number of hits might be smaller than the total number of hits (total) when using offset and limit

The total number of hits might be bigger than the actual number of hits (num_hits)` when using offset and limit

Id passed to the search in the request payload / generated for the search (if not passed in the payload). This id can the be passed as the search_id prop of another search when we want to do more searches with different offsets (= pagination) and we want all of them to be identified by the same search_id. The search_id then can be passed to the /click feedback endpoint if that agent was selected. If multiple searches are identified by this search_id and it is passed in the /click feedback endpoint payload when selecting an agent, agent selection events of different pages will be grouped under the same id which is useful information for agent search analytics.