We’ve migrated our documentation to a new site, which means some URLs have changed.
Audience
Audience
Breadcrumbs

/document/update

Push documents to the Cxense platform.

The user must be authenticated and have write permissions to both the site and the verified site for the url.

The site must have an explicitly configured language. When a document is updated via document/update the document will have auto recrawling disabled.


Request

The request object has the following fields:

Name

Type

Required

Description

siteId

String

Yes

The siteId the document belongs to.

url

String

Yes

The document url.

articleId

String

No

The article id. Used for duplicate removal in Cxense Content. Must be a numeric ascii value.

publishTime

String

No

The time when the document was published. ISO8601 (example: 2014-05-17T11:22:22+0000).

modifiedTime

String

No

The time when the document was modified. ISO8601 (example: 2014-05-17T11:22:22+0000 ).

expirationTime

String

No

The time when the document expires. Expired content is automatically removed in Cxense Content. Filtering out expired content from search results is optional so this can be added as a filter when applicable.

title

String

No

The document's title.

description

String

No

A description of the document.

pageclass

String

No

The pageclass. Valid values are article and frontpage.

sections

Array of Section objects

No

Array of sections from the document.

fields

Array of Field objects

No

Array of profile items.

author

Array of Strings

No

Array of author Strings.

dominantimage

Image object

No

Image object

Section

The section object has the following fields:

Name

Type

Required

Description

heading

String

No

The heading text for the section.

body

Array of Strings

No

The paragraphs for the section.

Field (of type string)

Name

Type

Required

Description

field

String

Yes

See general rules for field below. The value will undergo

shingle

processing if the name ends with "_shingle".

value

String

Yes

The field's value.

Field (of type set)

Name

Type

Required

Description

type

String

Yes

Most be the literal string "set".

field

String

Yes

See general rules for field below.

value

Array of String

Yes

The field's value. It is an unordered set, so there should be no duplicates and the order will not be preserved.

Field (of type number)

Name

Type

Required

Description

type

String

Yes

Must be the literal string "number".

field

String

Yes

See general rules for field below.

value

Number

Yes

The field's value.

Field (of type time)

Name

Type

Required

Description

type

String

Yes

Must be the literal string "time".

field

String

Yes

See general rules for field below.

value

String

Yes

The field's value formatted as combined date and time in UTC. Example: "2014-10-30T01:57:38.000Z".

Field (of type geo point)

Name

Type

Required

Description

type

String

Yes

Must be the literal string "geopoint".

field

String

Yes

See general rules for field below.

value

Geopoint

Yes

The field's value.

Geopoint

Name

Type

Required

Description

latitude

Number

Yes

The latitude (between -90 and 90).

longitude

Number

Yes

The longitude (between -180 and 180).

Field (of type image)

Name

Type

Required

Description

type

String

Yes

Must be the literal string "image".

field

String

Yes

See general rules for field below.

value

Image

Yes

The field's value.

Image

Name

Type

Required

Description

url

String

Yes

Must be a valid url that points to an image.

width

Number

Yes

The image width.

height

Number

Yes

The image height.

General rules for field

  • Must either

  • start with customer prefix followed by a dash,

  • be one of the following overriding fields: taxonomy, company, person, location, concept, entity, or

  • be one of the following Open Graph string fields og-image, og-title, og-type, og-url, og-audio, og-description, og-locale, og-site_name, og-video, og-updated_time

  • For the fields og-image, og-url, og-audio, og-video, the value must be a valid URL.

  • For the field og-updated_time, the value must be a valid ISO8601 datetime (example: 2014-05-17T11:22:22+0000).

  • For the field og-type the value must be at most 256 characters.

  • Must be less than or equal to 30 characters in length.

  • Must consist of ASCII characters that are either:

  • Lower case (a-z)

  • Hyphen (-)

  • Underscore (_)

  • Digit (0-9)

  • Multiple fields with the same field value is allowed.

Response

The response object is an empty json object on success.

Content profile

A subset of fields are used to create a content profile similarly to how a content profile is generated during document parsing. This is done using our language processing, standard taxonomy, language processing, url taxonomy and custom taxonomy support. Sentiment analysis will also be performed for the languages that are supported, when enabled for the site.

All fields are fed to the search index for the site. Additional fields that are a result of the various content processing steps will also be fed to the search index. This allows the search index to be used together with our other products, for instance Cxense Content.

Time to live

Time to live for documents is dependent on sub-system. For search it is 180 days, for content profiles it is 60 days.

Last updated: