StructuredResult.md

StructuredResult

A single object that can support any object in the work graph. Only a single object will be populated.

Fields

Field	Type	Required	Description	Example
document	Optional<Document>	➖	N/A
person	Optional<Person>	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
customer	Optional<Customer>	➖	N/A
team	Optional<Team>	➖	N/A
customEntity	Optional<CustomEntity>	➖	N/A
answer	Optional<Answer>	➖	N/A
generatedQna	Optional<GeneratedQna>	➖	N/A
extractedQnA	Optional<ExtractedQnA>	➖	N/A
meeting	Optional<Meeting>	➖	N/A
app	Optional<AppResult>	➖	N/A
collection	Optional<Collection>	➖	N/A
code	Optional<Code>	➖	N/A	{ "repoName": "scio", "fileName": "README.md", "matches": [ { "lineNumber": 1, "content": "Welcome to the beginning", "ranges": [] }, { "lineNumber": 2, "content": "Second line of the file", "ranges": [] }, { "lineNumber": 3, "content": "hello world hello world", "ranges": [ { "startindex": 0, "endIndex": 5 }, { "startIndex": 12, "endIndex": 17 } ] } ] }
shortcut	Optional<Shortcut>	➖	N/A
querySuggestions	Optional<QuerySuggestionList>	➖	N/A
chat	Optional<ChatMetadata>	➖	Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content.
relatedDocuments	List<RelatedDocuments>	➖	A list of documents related to this structured result.
relatedQuestion	Optional<RelatedQuestion>	➖	N/A
disambiguation	Optional<Disambiguation>	➖	A disambiguation between multiple entities with the same name
snippets	List<SearchResultSnippet>	➖	Any snippets associated to the populated object.
trackingToken	Optional<String>	➖	An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
prominence	Optional<Prominence>	➖	The level of visual distinction that should be given to a result.
source	Optional<StructuredResultSource>	➖	Source context for this result. Possible values depend on the result type.