Map of the types
Which family a type belongs to, what it relates to, and where the guide that explains it is — for the 130-odd types the library exports.
The library exports around 130 types. Your editor holds their exhaustive declarations, so this page does not repeat them: it answers the question autocompletion cannot, which family is this in and what does it connect to.
Nine families
Reading that diagram
The left column is the runtime exchange: you build a Query, the server answers a Result. The bottom is
the configuration an administrator wrote, which tells you what the left column is even allowed to contain.
Most confusion about this library is a confusion between the two.
The families in detail
Two naming conventions worth knowing
CC means server configuration. Anything prefixed CC was authored in the Sinequa administration console.
You read it; you never build it.
$ means client-side. A field whose name starts with $ was added by the library after the response
arrived — $hasMore, $path, $level, $error, $hasRelevantExtracts. The server never sends one, so nothing
outside this library will recognise it, and serialising it back into a request achieves nothing.
Where the declared type lies
Two cases where the type annotation is not the whole truth. Both are documented in their guide; collected here because they are the ones that cost debugging time.
| Symbol | Declared | Actually |
|---|---|---|
Article | no value / type | fetchQuery injects both into every record. Undeclared on purpose — read title |
fetchAggregation | Promise<Aggregation> | the response envelope is an AggregateResult, not a Result |
fetchQuery used to belong here, declaring Promise<Result> while returning the pagination fields too. Since
2.5.0 it declares Promise<Result & ResultPages>.