DocumentDefinition

Indexable document structure

Properties

Name Type Description Notes
datasource str
title str Document title, in plain text, if present. If not present, the title would be attempted to be extracted from the content. [optional]
filename 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. [optional]
container str The container name for the content (Folder for example for file content). [optional]
container_datasource_id str This represents the datasource sepcific id of the container. [optional]
container_object_type str This represents the object type of the container. It cannot have spaces or _ [optional]
object_type str The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _ [optional]
view_url 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).' [optional]
id str The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. [optional]
summary ContentDefinition [optional]
body ContentDefinition [optional]
author UserReferenceDefinition [optional]
owner UserReferenceDefinition [optional]
permissions DocumentPermissionsDefinition [optional]
created_at int The creation time, in epoch seconds. [optional]
updated_at int The last update time, in epoch seconds. [optional]
updated_by UserReferenceDefinition [optional]
tags [str] Labels associated with the document. [optional]
interactions DocumentInteractionsDefinition [optional]
status str [optional]
additional_urls [str] Additional variations of the URL that this document points to. [optional]
comments [CommentDefinition] Comments associated with the document. [optional]
custom_properties [CustomProperty] Additional metadata properties of the document. These can surface as facets and operators. [optional]
any string name bool, date, datetime, dict, float, int, list, str, none_type any string name can be used but the value must be the correct type [optional]

[Back to Model list] [Back to API list] [Back to README]