| Field | Type | Required | Description |
|---|---|---|---|
id_type |
models.IDType | ✔️ | Type of the id in the incoming request. |
id |
str | ✔️ | ID corresponding to the requested idType. Note that channel and threads are represented by the underlying datasource's ID and conversations are represented by their document's ID. |
workspace_id |
Optional[str] | ➖ | Id for the for the workspace in case of multiple workspaces. |
direction |
Optional[models.Direction] | ➖ | The direction of the results asked with respect to the reference timestamp. Missing field defaults to OLDER. Only applicable when using a message_id. |
timestamp_millis |
Optional[int] | ➖ | Timestamp in millis of the reference message. Only applicable when using a message_id. |
include_root_message |
Optional[bool] | ➖ | Whether to include root message in response. |
datasource |
models.Datasource | ✔️ | The type of the data source. |
datasource_instance_display_name |
Optional[str] | ➖ | The datasource instance display name from which the document was extracted. This is used for appinstance facet filter for datasources that support multiple instances. |