Skip to content

Suggest Entities

GET
/api/writing/entities/suggest

πŸ’‘ Get entity suggestions for auto-completion

Provides AI-powered entity suggestions based on semantic similarity. Enables intelligent auto-completion for character names, locations, organizations, and custom entities within the writing project.

Query Parameters:

  • query: Search query for entity suggestions (min 1 character)
  • limit: Maximum suggestions to return (1-50, default: 10)

Dependencies:

  • writing_service: Injected IshvanaWritingModule instance

Returns:

  • List of EntitySuggestion objects with name, type, description, and confidence

Raises:

  • HTTPException 500: If suggestion generation fails

Example Response:

[
    {
        "name": "Vinyata the Wise",
        "type": "character",
        "description": "Ancient lorekeeper",
        "confidence": 0.92
    }
]
query
required
Query

Search query for entity suggestions

string
>= 1 characters

Search query for entity suggestions

limit
Limit

Maximum number of suggestions

integer
default: 10 >= 1 <= 50

Maximum number of suggestions

Successful Response

Response Suggest Entities Api Writing Entities Suggest Get
Array<object>
EntitySuggestion

Lore entity auto-completion suggestion model.

Represents a suggested lore entity for auto-completion in the document editor, enabling quick entity references and consistency maintenance.

Fields: name: Entity name type: Entity type (character, location, faction, item, concept) confidence: Suggestion confidence score (0.0-1.0, higher is better match) context: Optional contextual information about the entity

Used By: - Entity auto-completion API - Document editor entity suggestions - Lore consistency checking - Entity reference insertion

object
name
required
Name
string
type
required
Type
string
confidence
required
Confidence
number
context
Any of:
string

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