documentdefinition.md

DocumentDefinition

Indexable document structure

Fields

Field	Type	Required	Description
title	Optional[str]	➖	Document title, in plain text, if present. If not present, the title would be attempted to be extracted from the content.
filename	Optional[str]	➖	Source filename, in plain text, for the document. May be used as a fallback title for the document, if the title is not provided and cannot be extracted from the content. Populate this if there is no explicit title for the document and the content is sourced from a file.
container	Optional[str]	➖	The container name for the content (Folder for example for file content).
container_datasource_id	Optional[str]	➖	This represents the datasource sepcific id of the container.
container_object_type	Optional[str]	➖	This represents the object type of the container. It cannot have spaces or _
datasource	str	✔️	N/A
object_type	Optional[str]	➖	The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _
view_url	Optional[str]	➖	The permalink for viewing the document. Note: viewURL is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false).'
id	Optional[str]	➖	The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. Note: id is a required field for datasources created after 1st March 2025
summary	Optional[models.ContentDefinition]	➖	Describes text content or base64 encoded binary content
body	Optional[models.ContentDefinition]	➖	Describes text content or base64 encoded binary content
author	Optional[models.UserReferenceDefinition]	➖	Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
owner	Optional[models.UserReferenceDefinition]	➖	Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
permissions	Optional[models.DocumentPermissionsDefinition]	➖	describes the access control details of the document
created_at	Optional[int]	➖	The creation time, in epoch seconds.
updated_at	Optional[int]	➖	The last update time, in epoch seconds.
updated_by	Optional[models.UserReferenceDefinition]	➖	Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
tags	List[str]	➖	Labels associated with the document.
interactions	Optional[models.DocumentInteractionsDefinition]	➖	describes the interactions on the document
status	Optional[str]	➖	N/A
additional_urls	List[str]	➖	Additional variations of the URL that this document points to.
comments	List[models.CommentDefinition]	➖	Comments associated with the document.
custom_properties	List[models.CustomProperty]	➖	Additional metadata properties of the document. These can surface as facets and operators.