Interface: SearchHit<TDocument>
Defined in: retrieval/src/types.ts:217
A search result hit.
Type Parameters
| Type Parameter | Default type |
|---|---|
TDocument | UnknownDocument |
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
document? | Partial<TDocument> | Projected document fields (can be partial due to include/exclude) | retrieval/src/types.ts:227 |
id | string | Document identifier | retrieval/src/types.ts:219 |
index | string | Index the document belongs to | retrieval/src/types.ts:221 |
namespace? | string | Optional namespace within the index | retrieval/src/types.ts:223 |
score | number | Relevance score for the hit | retrieval/src/types.ts:225 |