documentmetadata.md

DocumentMetadata

Fields

Field	Type	Required	Description	Example
datasource	Optional[str]	➖	N/A
datasource_instance	Optional[str]	➖	The datasource instance from which the document was extracted.
object_type	Optional[str]	➖	The type of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue type such as Bug or Feature Request).
container	Optional[str]	➖	The name of the container (higher level parent, not direct parent) of the result. Interpretation is specific to each datasource (e.g. Channels for Slack, Project for Jira). cf. parentId
container_id	Optional[str]	➖	The Glean Document ID of the container. Uniquely identifies the container.
super_container_id	Optional[str]	➖	The Glean Document ID of the super container. Super container represents a broader abstraction that contains many containers. For example, whereas container might refer to a folder, super container would refer to a drive.
parent_id	Optional[str]	➖	The id of the direct parent of the result. Interpretation is specific to each datasource (e.g. parent issue for Jira). cf. container
mime_type	Optional[str]	➖	N/A
document_id	Optional[str]	➖	The index-wide unique identifier.
logging_id	Optional[str]	➖	A unique identifier used to represent the document in any logging or feedback requests in place of documentId.
document_id_hash	Optional[str]	➖	Hash of the Glean Document ID.
create_time	date	➖	N/A
update_time	date	➖	N/A
author	Optional[models.Person]	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
owner	Optional[models.Person]	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
mentioned_people	List[models.Person]	➖	A list of people mentioned in the document.
visibility	Optional[models.DocumentVisibility]	➖	The level of visibility of the document as understood by our system.
components	List[str]	➖	A list of components this result is associated with. Interpretation is specific to each datasource. (e.g. for Jira issues, these are components.)
status	Optional[str]	➖	The status or disposition of the result. Interpretation is specific to each datasource. (e.g. for Jira issues, this is the issue status such as Done, In Progress or Will Not Fix).
status_category	Optional[str]	➖	The status category of the result. Meant to be more general than status. Interpretation is specific to each datasource.
pins	List[models.PinDocument]	➖	A list of stars associated with this result. "Pin" is an older name.
priority	Optional[str]	➖	The document priority. Interpretation is datasource specific.
assigned_to	Optional[models.Person]	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
updated_by	Optional[models.Person]	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
labels	List[str]	➖	A list of tags for the document. Interpretation is datasource specific.
collections	List[models.Collection]	➖	A list of collections that the document belongs to.
datasource_id	Optional[str]	➖	The user-visible datasource specific id (e.g. Salesforce case number for example, GitHub PR number).
interactions	Optional[models.DocumentInteractions]	➖	N/A
verification	Optional[models.Verification]	➖	N/A
viewer_info	Optional[models.ViewerInfo]	➖	N/A
permissions	Optional[models.ObjectPermissions]	➖	N/A
visit_count	Optional[models.CountInfo]	➖	N/A
shortcuts	List[models.Shortcut]	➖	A list of shortcuts of which destination URL is for the document.
path	Optional[str]	➖	For file datasources like onedrive/github etc this has the path to the file
custom_data	Dict[str, models.CustomDataValue]	➖	Custom fields specific to individual datasources
document_category	Optional[str]	➖	The document's document_category(.proto).
contact_person	Optional[models.Person]	➖	N/A	{ "name": "George Clooney", "obfuscatedId": "abc123" }
thumbnail	Optional[models.Thumbnail]	➖	N/A
index_status	Optional[models.IndexStatus]	➖	N/A
ancestors	List[models.Document]	➖	A list of documents that are ancestors of this document in the hierarchy of the document's datasource, for example parent folders or containers. Ancestors can be of different types and some may not be indexed. Higher level ancestors appear earlier in the list.