| Field | Type | Required | Description | Example |
|---|---|---|---|---|
structured_results |
List[models.StructuredResult] | ➖ | An array of entities in the work graph retrieved via a data request. | |
tracking_token |
Optional[str] | ➖ | An opaque token that represents this particular result in this particular query. To be used for /feedback reporting. | |
document |
Optional[models.Document] | ➖ | N/A | |
title |
Optional[str] | ➖ | N/A | |
url |
str | ✔️ | N/A | |
native_app_url |
Optional[str] | ➖ | A deep link, if available, into the datasource's native application for the user's platform (e.g. slack://...). | |
snippets |
List[models.SearchResultSnippet] | ➖ | Text content from the result document which contains search query terms, if available. | |
full_text |
Optional[str] | ➖ | The full body text of the result if not already contained in the snippets. Only populated for conversation results (e.g. results from a messaging app such as Slack). | |
full_text_list |
List[str] | ➖ | The full body text of the result if not already contained in the snippets; each item in the array represents a separate line in the original text. Only populated for conversation results (e.g. results from a messaging app such as Slack). | |
related_results |
List[models.RelatedDocuments] | ➖ | A list of results related to this search result. Eg. for conversation results it contains individual messages from the conversation document which will be shown on SERP. | |
clustered_results |
List[models.SearchResult] | ➖ | A list of results that should be displayed as associated with this result. | |
all_clustered_results |
List[models.ClusterGroup] | ➖ | A list of results that should be displayed as associated with this result. | |
attachment_count |
Optional[int] | ➖ | The total number of attachments. | |
attachments |
List[models.SearchResult] | ➖ | A (potentially partial) list of results representing documents attached to the main result document. | |
backlink_results |
List[models.SearchResult] | ➖ | A list of results that should be displayed as backlinks of this result in reverse chronological order. | |
cluster_type |
Optional[models.ClusterTypeEnum] | ➖ | The reason for inclusion of clusteredResults. | |
must_include_suggestions |
Optional[models.QuerySuggestionList] | ➖ | N/A | |
query_suggestion |
Optional[models.QuerySuggestion] | ➖ | N/A | { "query": "app:github type:pull author:mortimer", "label": "Mortimer's PRs", "datasource": "github" } |
prominence |
Optional[models.SearchResultProminenceEnum] | ➖ | The level of visual distinction that should be given to a result. |
|
attachment_context |
Optional[str] | ➖ | Additional context for the relationship between the result and the document it's attached to. | |
pins |
List[models.PinDocument] | ➖ | A list of pins associated with this search result. |