Heratio Framework API Reference

SearchIntegrationService
in package

Search Integration Service Bridges semantic search with standard AtoM browse

Table of Contents

Methods

__construct()  : mixed
buildSynonymClauses()  : array<string|int, mixed>
Build Elasticsearch should clauses for synonym expansion
enhanceQuery()  : array<string|int, mixed>
Enhance a search query with synonyms
getStats()  : array<string|int, mixed>
Get statistics about the thesaurus
getSuggestions()  : array<string|int, mixed>
Get search suggestions
isEnhancedSearchEnabled()  : bool
Check if enhanced search is enabled globally
logSearch()  : void
Log search for learning

Methods

buildSynonymClauses()

Build Elasticsearch should clauses for synonym expansion

public buildSynonymClauses(array<string|int, mixed> $synonyms) : array<string|int, mixed>
Parameters
$synonyms : array<string|int, mixed>
Return values
array<string|int, mixed>

enhanceQuery()

Enhance a search query with synonyms

public enhanceQuery(string $query[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$query : string
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getStats()

Get statistics about the thesaurus

public getStats() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSuggestions()

Get search suggestions

public getSuggestions(string $prefix[, int $limit = 8 ]) : array<string|int, mixed>
Parameters
$prefix : string
$limit : int = 8
Return values
array<string|int, mixed>

isEnhancedSearchEnabled()

Check if enhanced search is enabled globally

public isEnhancedSearchEnabled() : bool
Return values
bool

logSearch()

Log search for learning

public logSearch(string $query, int $resultCount) : void
Parameters
$query : string
$resultCount : int

        
On this page

Search results