| Field | Type | Required | Description | Example |
|---|---|---|---|---|
relation |
Optional<Relation> | ➖ | How this document relates to the including entity. | |
associatedEntityId |
Optional<String> | ➖ | Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) | |
querySuggestion |
Optional<QuerySuggestion> | ➖ | N/A | { "query": "app:github type:pull author:mortimer", "label": "Mortimer's PRs", "datasource": "github" } |
documents |
List<Document> | ➖ | : warning: ** DEPRECATED **: Deprecated on 2026-02-05, removal scheduled for 2026-10-15: Field is deprecated. A truncated list of documents with this relation. TO BE DEPRECATED. |
|
results |
List<SearchResult> | ➖ | A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken. |