Skip to content

Save Document Entities

POST
/api/writing/documents/{document_id}/entities

Save detected entities for a document to persist across restarts.

document_id
required
Document Id
string
SaveDocumentEntitiesRequest

Request to save detected entities for a document.

object
entities
required
Entities
Array<object>
PersistedEntityItem

A persisted entity for a document, returned when loading saved entities.

object
entity
required
Entity
string
entityType
required
Entitytype
string
confidence
required
Confidence
number
description
Description
string
""
status
Status
string
default: detected
Allowed values: detected confirmed denied
loreEntryId
Any of:
string
loreEntryTitle
Any of:
string

Successful Response

DocumentEntitiesResponse

Response with all persisted entities for a document.

object
documentId
required
Documentid
string
entities
required
Entities
Array<object>
PersistedEntityItem

A persisted entity for a document, returned when loading saved entities.

object
entity
required
Entity
string
entityType
required
Entitytype
string
confidence
required
Confidence
number
description
Description
string
""
status
Status
string
default: detected
Allowed values: detected confirmed denied
loreEntryId
Any of:
string
loreEntryTitle
Any of:
string
total
required
Total
integer

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object