Skip to main content

models

Pydantic models for API requests and responses.

This module defines the request and response schemas for the model service API endpoints, including video summarization, ontology augmentation, and object detection.

Any​

Literal​

BaseModel​

Field​

SummarizeRequest Objects​

class SummarizeRequest(BaseModel)

Request model for video summarization endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

video_id​

video_path​

persona_id​

persona_role​

information_need​

frame_sample_rate​

max_frames​

enable_audio​

audio_language​

enable_speaker_diarization​

fusion_strategy​

KeyFrame Objects​

class KeyFrame(BaseModel)

Key frame information from video analysis.

Fields are validated using Pydantic. See Field descriptions for details.

frame_number​

timestamp​

description​

confidence​

SummarizeResponse Objects​

class SummarizeResponse(BaseModel)

Response model for video summarization endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

id​

video_id​

persona_id​

summary​

visual_analysis​

audio_transcript​

key_frames​

confidence​

transcript_json​

audio_language​

speaker_count​

audio_model_used​

visual_model_used​

fusion_strategy​

processing_time_audio​

processing_time_visual​

processing_time_fusion​

OntologyType Objects​

class OntologyType(BaseModel)

Suggested ontology type from augmentation.

Fields are validated using Pydantic. See Field descriptions for details.

name​

description​

parent​

confidence​

examples​

AugmentRequest Objects​

class AugmentRequest(BaseModel)

Request model for ontology augmentation endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

persona_id​

domain​

existing_types​

target_category​

max_suggestions​

AugmentResponse Objects​

class AugmentResponse(BaseModel)

Response model for ontology augmentation endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

id​

persona_id​

target_category​

suggestions​

reasoning​

BoundingBox Objects​

class BoundingBox(BaseModel)

Bounding box coordinates for object detection.

Fields are validated using Pydantic. See Field descriptions for details.

x​

y​

width​

height​

Detection Objects​

class Detection(BaseModel)

Single object detection result.

Fields are validated using Pydantic. See Field descriptions for details.

label​

bounding_box​

confidence​

track_id​

DetectionRequest Objects​

class DetectionRequest(BaseModel)

Request model for object detection endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

video_id​

query​

video_path​

frame_numbers​

confidence_threshold​

enable_tracking​

FrameDetections Objects​

class FrameDetections(BaseModel)

Detections for a single video frame.

Fields are validated using Pydantic. See Field descriptions for details.

frame_number​

timestamp​

detections​

DetectionResponse Objects​

class DetectionResponse(BaseModel)

Response model for object detection endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

id​

video_id​

query​

frames​

total_detections​

processing_time​

TrackingMaskData Objects​

class TrackingMaskData(BaseModel)

RLE-encoded segmentation mask for tracked object.

Fields are validated using Pydantic. See Field descriptions for details.

object_id​

mask_rle​

confidence​

is_occluded​

TrackingFrameResult Objects​

class TrackingFrameResult(BaseModel)

Tracking results for a single video frame.

Fields are validated using Pydantic. See Field descriptions for details.

frame_number​

timestamp​

masks​

processing_time​

TrackingRequest Objects​

class TrackingRequest(BaseModel)

Request model for object tracking endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

video_id​

initial_masks​

object_ids​

frame_numbers​

TrackingResponse Objects​

class TrackingResponse(BaseModel)

Response model for object tracking endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

id​

video_id​

frames​

video_width​

video_height​

total_frames​

processing_time​

fps​

ErrorResponse Objects​

class ErrorResponse(BaseModel)

Error response model for API errors.

Fields are validated using Pydantic. See Field descriptions for details.

error​

message​

details​

ClaimExtractionRequest Objects​

class ClaimExtractionRequest(BaseModel)

Request model for claim extraction endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

summary_id​

summary_text​

sentences​

annotations​

ontology_types​

ontology_glosses​

extraction_strategy​

max_claims​

min_confidence​

ExtractedClaim Objects​

class ExtractedClaim(BaseModel)

Single extracted claim with metadata.

Fields are validated using Pydantic. See Field descriptions for details.

text​

sentence_index​

char_start​

char_end​

subclaims​

confidence​

claim_type​

ClaimExtractionResponse Objects​

class ClaimExtractionResponse(BaseModel)

Response model for claim extraction endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

summary_id​

claims​

model_used​

processing_time​

ClaimSource Objects​

class ClaimSource(BaseModel)

Source of claims for synthesis (single video or collection).

Fields are validated using Pydantic. See Field descriptions for details.

source_id​

source_type​

claims​

metadata​

ClaimRelationship Objects​

class ClaimRelationship(BaseModel)

Relationship between claims across sources.

Fields are validated using Pydantic. See Field descriptions for details.

source_claim_id​

target_claim_id​

relation_type​

confidence​

notes​

SummarySynthesisRequest Objects​

class SummarySynthesisRequest(BaseModel)

Request model for summary synthesis endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

summary_id​

claim_sources​

claim_relations​

ontology_context​

persona_context​

synthesis_strategy​

max_length​

include_conflicts​

include_citations​

SummarySynthesisResponse Objects​

class SummarySynthesisResponse(BaseModel)

Response model for summary synthesis endpoint.

Fields are validated using Pydantic. See Field descriptions for details.

summary_id​

summary_gloss​

model_used​

processing_time​

claims_used​

synthesis_metadata​