Heratio Framework API Reference

QueryUnderstandingService
in package

Query Understanding Service.

Parses natural language queries into structured search parameters. Handles intent classification, entity extraction, and query expansion.

Table of Contents

Constants

ENTITY_DATE  = 'date'
ENTITY_FORMAT  = 'format'
ENTITY_ORGANIZATION  = 'organization'
ENTITY_PERSON  = 'person'
Entity types.
ENTITY_PLACE  = 'place'
ENTITY_SUBJECT  = 'subject'
INTENT_COMPARE  = 'compare'
INTENT_EXPLORE  = 'explore'
INTENT_FIND  = 'find'
Query intents.
INTENT_IDENTIFY  = 'identify'
INTENT_LOCATE  = 'locate'
INTENT_TRACE  = 'trace'

Methods

__construct()  : mixed
classifyIntent()  : string
Classify the user's intent.
detectLanguage()  : string
Detect query language.
expandQuery()  : array<string|int, mixed>
Expand query with synonyms and related terms.
extractEntities()  : array<string|int, mixed>
Extract entities from query.
getCulture()  : string
Get current culture.
parse()  : array<string|int, mixed>
Parse a natural language query.
parseTimeReferences()  : array<string|int, mixed>
Parse time references from query.
setCulture()  : self
Set the culture for queries.

Constants

Methods

classifyIntent()

Classify the user's intent.

public classifyIntent(string $query) : string
Parameters
$query : string
Return values
string

detectLanguage()

Detect query language.

public detectLanguage(string $query) : string
Parameters
$query : string
Return values
string

expandQuery()

Expand query with synonyms and related terms.

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

extractEntities()

Extract entities from query.

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

parse()

Parse a natural language query.

public parse(string $query) : array<string|int, mixed>
Parameters
$query : string

Raw user query

Return values
array<string|int, mixed> —

Structured query object

parseTimeReferences()

Parse time references from query.

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

setCulture()

Set the culture for queries.

public setCulture(string $culture) : self
Parameters
$culture : string
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results