| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
Optional[str] | ➖ | The Glean Document ID. | |
datasource |
Optional[str] | ➖ | The app or other repository type from which the document was extracted | |
connector_type |
Optional[models.ConnectorType] | ➖ | The source from which document content was pulled, e.g. an API crawl or browser history | |
doc_type |
Optional[str] | ➖ | The datasource-specific type of the document (e.g. for Jira issues, this is the issue type such as Bug or Feature Request). | |
content |
Optional[models.DocumentContent] | ➖ | N/A | |
container_document |
Optional[models.Document] | ➖ | N/A | |
parent_document |
Optional[models.Document] | ➖ | N/A | |
title |
Optional[str] | ➖ | The title of the document. | |
url |
Optional[str] | ➖ | A permalink for the document. | |
metadata |
Optional[models.DocumentMetadata] | ➖ | N/A | { "container": "container", "parentId": "JIRA_EN-1337", "createTime": "2000-01-23T04:56:07.000Z", "datasource": "datasource", "author": { "name": "name" }, "documentId": "documentId", "updateTime": "2000-01-23T04:56:07.000Z", "mimeType": "mimeType", "objectType": "Feature Request", "components": [ "Backend", "Networking" ], "status": [ "Done" ], "customData": { "someCustomField": "someCustomValue" } } |
sections |
List[models.DocumentSection] | ➖ | A list of content sub-sections in the document, e.g. text blocks with different headings in a Drive doc or Confluence page. |