Skip to content

Detect Entities

POST
/api/creative/lore/auto-link/detect

Detect entities in text content using semantic search.

DetectEntitiesRequest

Request body for entity detection.

object
content
required
Content

Text content to analyze

string
minConfidence
Minconfidence

Minimum confidence threshold

number
default: 0.7 <= 1
maxSuggestions
Maxsuggestions

Maximum suggestions to return

integer
default: 20 >= 1 <= 100
maxCandidates
Maxcandidates

Max candidates to evaluate (performance vs completeness)

integer
default: 50 >= 10 <= 500
knownEraLabels
Any of:
Array<string>

Successful Response

DetectEntitiesResponse

Response for entity detection.

object
status
required
Status
string
matches
required
Matches
Array<object>
EntityMatchResponse

Single entity match with confidence and metadata.

object
entity
required
Entity
string
confidence
required
Confidence
number
type
required
Type
string
description
Description
string
""
startPos
Startpos
integer
0
endPos
Endpos
integer
0
loreEntryId
Any of:
string
loreEntryTitle
Any of:
string
portraitUrl
Any of:
string
aliases
Aliases
Array<string>
processingTime
required
Processingtime
number

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