| Field | Type | Required | Description | Example |
|---|---|---|---|---|
relation |
Optional[models.Relation] | ➖ | How this document relates to the including entity. | |
associated_entity_id |
Optional[str] | ➖ | Which entity in the response that this entity relates to. Relevant when there are multiple entities associated with the response (such as merged customers) | |
query_suggestion |
Optional[models.QuerySuggestion] | ➖ | N/A | { "query": "app:github type:pull author:mortimer", "label": "Mortimer's PRs", "datasource": "github" } |
documents |
List[models.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[models.SearchResult] | ➖ | A truncated list of documents associated with this relation. To be used in favor of documents because it contains a trackingToken. |