Schemas

Profile Models

Data structures for user profiles — searching, retrieving, deleting profiles and tracking profile changes.

UserProfilemodel

Represents a user profile generated from user interactions.

Prop	Type
`profile_id`	string
`user_id`	string
`content`	string
`last_modified_timestamp`	integer
`generated_from_request_id`	string
`profile_time_to_live`	ProfileTimeToLive
`expiration_timestamp`	integer
`custom_features`	object
`source`	string
`status`	Status
`extractor_names`	array[string]
`source_span`	string \| null

SearchUserProfileRequestrequest model

Request model for searching user profiles.

Prop	Type
`user_id`	string
`query`	string
`source`	string
`custom_feature`	string
`extractor_name`	string
`tags`	array[string]
`generated_from_request_id`	string
`start_time`	datetime
`end_time`	datetime
`threshold`	float
`enable_reformulation`	boolean
`search_mode`	SearchMode
`top_k`	integer

SearchUserProfileResponseresponse model

Response model for profile search requests.

Prop	Type
`success`	boolean
`user_profiles`	array[UserProfile]
`msg`	string

GetUserProfilesRequestrequest model

Request model for getting user profiles.

Prop	Type
`user_id`	string
`profile_id`	string
`query`	string
`start_time`	datetime
`end_time`	datetime
`top_k`	integer
`source`	string
`profile_time_to_live`	string
`status_filter`	array[Status]
`tags`	array[string]

GetUserProfilesResponseresponse model

Response model for getting user profiles.

Prop	Type
`success`	boolean
`user_profiles`	array[UserProfile]
`msg`	string

AddUserProfileRequestrequest model

Request model for adding user profiles directly to storage (manual injection, bypassing the inference pipeline). Each profile must have non-empty content for embedding.

Prop	Type
`user_profiles`	array[UserProfile]

AddUserProfileResponseresponse model

Response model for adding user profiles.

Prop	Type
`success`	boolean
`message`	string
`added_count`	integer

DeleteUserProfileRequestrequest model

Request model for deleting a user profile.

Prop	Type
`user_id`	string
`profile_id`	string
`search_query`	string

DeleteUserProfileResponseresponse model

Response model for profile deletion requests.

Prop	Type
`success`	boolean
`message`	string

ProfileChangeLogmodel

Represents a log entry tracking changes to user profiles.

Prop	Type
`id`	integer
`user_id`	string
`request_id`	string
`created_at`	integer
`added_profiles`	array[UserProfile]
`removed_profiles`	array[UserProfile]

ProfileChangeLogResponseresponse model

Response model for profile change log requests.

Prop	Type
`success`	boolean
`profile_change_logs`	array[ProfileChangeLog]

RerunProfileGenerationRequestrequest model

Request model for rerunning profile generation.

Prop	Type
`user_id`	string
`start_time`	datetime
`end_time`	datetime
`source`	string
`extractor_names`	array[string]

RerunProfileGenerationResponseresponse model

Response model for profile generation rerun requests.

Prop	Type
`success`	boolean
`msg`	string
`profiles_generated`	integer
`operation_id`	string

ManualProfileGenerationRequestrequest model

Request model for manually triggering profile generation with window-sized interactions. Creates profiles with CURRENT status directly (no upgrade needed).

Prop	Type
`user_id`	string
`source`	string
`extractor_names`	array[string]

ManualProfileGenerationResponseresponse model

Response model for manual profile generation.

Prop	Type
`success`	boolean
`msg`	string
`profiles_generated`	integer

PreviousPlaybook Models Next Request Models