Spark Object Models
Objects used to build Spark handoff messages and parse Spark responses.
nexthink_api.Spark
Models for the Nexthink Spark API.
NxtSparkErrorResponse
Bases: BaseModel
Error details returned by the Spark API.
message: str | None = None
class-attribute
instance-attribute
NxtSparkHandoffConversationMessageRequest
Bases: BaseModel
Request body used to hand off a user conversation to Spark.
message: NxtSparkMessageDTO
instance-attribute
metadata: dict[str, str] | None = None
class-attribute
instance-attribute
NxtSparkHandoffSuccessResponse
Bases: BaseModel
Typed success marker for Spark handoff 204 No Content responses.
accepted: bool = True
class-attribute
instance-attribute
NxtSparkMessageDTO
Bases: BaseModel
Message payload handed off to Spark.
parts: list[NxtSparkTextPartDTO | NxtSparkFilePartByContent] = Field(min_length=1)
class-attribute
instance-attribute
NxtSparkFilePartByContent
Bases: BaseModel
File message part handed off to Spark by content.
type: NxtSparkPartType = NxtSparkPartType.FILE
class-attribute
instance-attribute
fileContent: str
instance-attribute
mimeType: str = Field(min_length=1)
class-attribute
instance-attribute
NxtSparkPartType
Bases: str, Enum
Supported Spark message part types.
TEXT = 'TEXT'
class-attribute
instance-attribute
FILE = 'FILE'
class-attribute
instance-attribute
NxtSparkTextPartDTO
Bases: BaseModel
Text message part handed off to Spark.