Skip to content
Ishvana Ishvana Docs

Confirm Entity

POST
/api/writing/entities/{entity_name}/confirm

Confirm a detected entity — persists it with confidence 1.0.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
entity_name
required
Entity Name
string

Request Body required

Section titled “Request Body required ”
EntityConfirmRequest

Request to confirm or deny a detected entity.

object
entityType
Entitytype

Entity type

string
default: unknown
description
Description

Entity description

string
""
documentId
Any of:
string
confidence
Confidence

Confidence score

number
default: 1 <= 1

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

EntityConfirmResponse

Response from confirming or denying an entity.

object
status
required
Status
string
entityName
required
Entityname
string
action
required
Action

‘confirmed’ or ‘denied’

string
message
Any of:
string

422

Section titled “422 ”

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