Skip to content

Latest commit

 

History

History
31 lines (27 loc) · 42.4 KB

structuredresult.md

File metadata and controls

31 lines (27 loc) · 42.4 KB

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[models.Document] ➖ N/A
person Optional[models.Person] ➖ N/A {
"name": "George Clooney",
"obfuscatedId": "abc123"
}
customer Optional[models.Customer] ➖ N/A
team Optional[models.Team] ➖ N/A
custom_entity Optional[models.CustomEntity] ➖ N/A
answer Optional[models.Answer] ➖ N/A
generated_qna Optional[models.GeneratedQna] ➖ N/A
extracted_qn_a Optional[models.ExtractedQnA] ➖ N/A
meeting Optional[models.Meeting] ➖ N/A
app Optional[models.AppResult] ➖ N/A
collection Optional[models.Collection] ➖ N/A
code Optional[models.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[models.Shortcut] ➖ N/A
query_suggestions Optional[models.QuerySuggestionList] ➖ N/A
chat Optional[models.ChatMetadata] ➖ Metadata of a Chat a user had with Glean Assistant. This contains no actual conversational content.
related_documents List[models.RelatedDocuments] ➖ A list of documents related to this structured result.
related_question Optional[models.RelatedQuestion] ➖ N/A
disambiguation Optional[models.Disambiguation] ➖ A disambiguation between multiple entities with the same name
snippets List[models.SearchResultSnippet] ➖ Any snippets associated to the populated object.
tracking_token Optional[str] ➖ An opaque token that represents this particular result in this particular query. To be used for /feedback reporting.
prominence Optional[models.Prominence] ➖ The level of visual distinction that should be given to a result.
source Optional[models.StructuredResultSource] ➖ Source context for this result. Possible values depend on the result type.