voplica.types.file

The protobuf package voplica.types.file: 0 services, 34 messages and 0 enums, defined in voplica/types/file/file_mpa_analysis.proto, voplica/types/file/files.proto.

Messages

FileMpaAnalysis

The platform’s content-rating analysis of a file: the rating it found and why, the media style, the findings and hazard categories behind it, and which analyzer ran it, when.

Field	Number	Type	Label	Description
mpa_rating	1	voplica.types.base.MPARating		Analyzed rating for this file.
style	5	voplica.types.base.MediaStyle
style_confidence	6	`float`
findings	7	FileMpaAnalysis.MpaFinding	repeated	Capped (<=16), sorted by severity.
hazard_categories	8	voplica.types.base.HazardCategory	repeated
suggested_tags	9	`string`	repeated	Capped (<=10), sanitized upstream of use.
rating_reason	10	`string`		Short human text, e.g. “exposed buttocks”.
transcript_excerpt	11	`string`	optional	<=2000 chars, audio/video only.
analyzer_version	13	`string`		Pipeline version tag, e.g. “mpa-v1”.
analyzed_at	14	`uint64`

FileMpaAnalysis.MpaFinding

A single detected finding and the rating it implies.

Field	Number	Type
label	1	`string`
implied_rating	2	voplica.types.base.MPARating
confidence	3	`float`

AllMatch

No fields.

Asset

Field	Number	Type	Label	Description
id	1	`string`
owner_id	2	`string`
asset_type	3	voplica.types.base.AssetType
visibility	4	voplica.types.base.VisibilityType		Visibility is inferred from referenced entities where the resource is used. By default any asset is PRIVATE. If the user creates a public post - the associated assets will become public. If the user create public content generation - the associated assets will become public. All file uploads will create Private asset, but if it’s published in a public space - it becomes public as well.
created_at	5	`int64`
user_modifications_lock	6	voplica.types.base.LockStatus		Shows if the user can freely add / remove files or file variant groups to this asset. If the status is locked - user can’t attach new file uploads to the asset. If the status is unlocked - user can freely upload / overwrite any files in the asset.
readiness_status	7	voplica.types.base.ReadinessStatus
mpa_rating	8	voplica.types.base.MPARating	optional
mpa_rating_source	9	voplica.types.base.AssetMpaRatingSource		Who set `mpa_rating`. ESTIMATED is a placeholder the analysis overwrites (it may LOWER it); ANALYSIS / PROVIDER / ADMIN short-circuit a later verification; USER is the owner’s raise-only edit, never below `analyzed_mpa_rating`, and never a reason to skip the analysis.
moderation_status	13	voplica.types.base.ContentModerationStatus
analyzed_mpa_rating	14	voplica.types.base.MPARating	optional	The analysis’ own rating, a ratchet (a re-analysis may raise it, never lower it) - the FLOOR of the owner’s edit. Absent until an analysis has been applied.
readiness_message	15	`string`	optional
hidden_from_non_owners	16	`bool`
mpa_publication_pending	17	`bool`
visible_from_public_cap	18	voplica.types.base.MPARating	optional

AssetFileVariantGroups

Field	Number	Type	Label
asset_id	1	`string`
asset_type	2	voplica.types.base.AssetType
asset_readiness	3	voplica.types.base.ReadinessStatus
file_variant_groups	4	FileVariantGroup	repeated
mpa_rating	5	voplica.types.base.MPARating	optional
moderation_status	6	voplica.types.base.ContentModerationStatus
readiness_message	7	`string`	optional
hidden_from_non_owners	8	`bool`
mpa_publication_pending	9	`bool`
visible_from_public_cap	10	voplica.types.base.MPARating	optional

AssetSelectionStrategy

Field	Number	Type	Label	Description
use_asset_id	1	`string`	oneof `strategy`	Asset ID must already be added as a preview to the used entity.
use_latest_asset	2	`google.protobuf.Empty`	oneof `strategy`	Do not set default preview explicitly. Instead, always use the latest added preview as the default.

AudioInfo

Field	Number	Type
length_ms	1	`uint64`
codec	2	voplica.types.file.codec.AudioCodecType
profile	3	voplica.types.file.codec.profile.AudioCodecProfileType
bit_rate	4	`uint64`
sample_rate	5	`uint32`
channels_count	6	`uint32`

AudioVariantFilter

Field	Number	Type	Label	Description
codecs	1	voplica.types.file.codec.AudioCodecType	repeated	First ordered codec has higher preference over the next codec. If `all_matches == False` then additional codecs are used as fallback codecs. If `all_matches == True` then variants per each resolution filter is returned. e.g. [AUDIO_CODEC_VORBIS, AUDIO_CODEC_OPUS, AUDIO_CODEC_AAC] If none are specified - it means any/all codec
all	10	AllMatch	oneof `bitrate`	Returns audio variants with any bitrate
max	11	MaxMatch	oneof `bitrate`	Returns the audio variant with highest bitrate requested
min	12	MinMatch	oneof `bitrate`	Returns the audio variant with smallest bitrate requested

CharacterLookAssetFileReference

Field	Number	Type	Description
look_id	1	`string`	ID of the character look the asset is attached to.
asset_id	2	`string`	ID of the asset within that look (`CharacterLookAsset.asset_id`).
file_ref	3	FileReferenceFromFileVariantGroup	File reference that is part of that asset (a DERIVED file of one of the asset’s groups).

CharacterPreviewAssetFileReference

Field	Number	Type	Description
character_id	1	`string`
asset_id	2	`string`	Must be one of the character’s PREVIEW assets.
file_ref	3	FileReferenceFromFileVariantGroup

ContentFileReference

Reference to a file within a content

Field	Number	Type	Label	Description
content_id	1	`string`		ID of the content
file_ref	2	FileReferenceFromFileVariantGroup		File reference that is part of any asset within the content

FileInfo

Field	Number	Type	Label	Description
id	1	`string`
size_bytes	2	`int64`
uri	3	`string`
mime_type	4	voplica.types.base.MimeType
creation_timestamp	5	`int64`
chunk_size_used	6	`int32`	optional
file_name	7	`string`	optional
derived_from_group_id	8	`string`	optional
uri_partition	9	voplica.types.file.meta.FilePartitionType		describes how `uri` should be used
owner_id	10	`string`
metadata	11	FileInfoMetadata
mpa_analysis	12	FileMpaAnalysis	optional

FileInfoMetadata

Field	Number	Type	Label
object	1	ObjectInfo	oneof `metadata`
image	2	ImageInfo	oneof `metadata`
video	3	VideoInfo	oneof `metadata`
audio	4	AudioInfo	oneof `metadata`
model_gen	5	ModelGenInfo	oneof `metadata`
vector_graphic	6	VectorGraphicInfo	oneof `metadata`

FileReference

Field	Number	Type	Label	Description
file_id	1	`string`	oneof `reference`	Direct reference by file id
file_info	2	FileInfo	oneof `reference`	Reference by providing the whole FileInfo. Useful for Orchestrator Nodes.
file_ref	3	FileReferenceFromFileVariantGroup	oneof `reference`	File reference of a file variant group (user must be the owner of the file to use this method)
content_file_ref	4	ContentFileReference	oneof `reference`	Reference to an asset within a specific content (user must have read permissions)
character_look_asset_file_ref	5	CharacterLookAssetFileReference	oneof `reference`
character_preview_asset_file_ref	6	CharacterPreviewAssetFileReference	oneof `reference`	Reference to an asset attached to a CHARACTER itself (a preview), not to one of its looks.
voice_reference_audio_file_ref	7	VoiceReferenceAudioFileReference	oneof `reference`

FileReferenceFromFileVariantGroup

Field	Number	Type	Label	Description
file_variant_group_id	1	`string`
file_id	2	`string`

FileVariantFilter

Field	Number	Type	Label	Description
flow_type	1	voplica.types.file.convert.ConvertFlowType	optional	if not provided it means - all convert flow flow types
presentation_type	2	voplica.types.base.ContentPresentationType	optional	if not provided it means - all presentation types
return_all_matched_files	3	`bool`		if `true` it returns all matched files. if `false` it returns only the best matched file (or none if no matches).
no_op	10	NoOpFilter	oneof `variant`	to return all / any files
skip_all	11	SkipAllFilter	oneof `variant`	to return no files
image	12	ImageVariantFilter	oneof `variant`
video	13	VideoVariantFilter	oneof `variant`
audio	14	AudioVariantFilter	oneof `variant`
model_gen	15	ModelGenVariantFilter	oneof `variant`
vector_graphic	16	VectorGraphicVariantFilter	oneof `variant`

FileVariantGroup

Field	Number	Type	Label	Description
id	1	`string`
owner_id	2	`string`
asset_id	3	`string`
source_file_id	4	`string`	optional	if source file id is null it means it was removed
source_file_type	5	voplica.types.base.FileType	optional
created_at	6	`int64`
flow_type	7	voplica.types.file.convert.ConvertFlowType		Convert flow that produced this file variant group
presentation_type	8	voplica.types.base.ContentPresentationType
derived_file_type	9	voplica.types.base.FileType
derived_files	10	FileInfo	repeated

FilesRetriever

Field	Number	Type	Label	Description
file_variant_filters	1	FileVariantFilter	repeated	If provided, the found file variant groups will be returned for the requested asset(s)
max_mpa_rating	2	voplica.types.base.MPARating	optional

FitResolution

Field	Number	Type	Label	Description
size	1	voplica.types.image.ImageSize
fallback_closest	2	`bool`		If none found, then fallbacks to the closest resolution: - fit_out: if none is found, then it falls back to the greatest image. - fit_in: if none is found, then it falls back to the smallest image.

ImageInfo

Field	Number	Type	Label	Description
width	1	`uint32`
height	2	`uint32`

ImageVariantFilter

Field	Number	Type	Label	Description
formats	1	voplica.types.base.MimeType	repeated	First ordered format has higher preference over the next format. If `all_matches == False` then additional formats are used as fallback formats. If `all_matches == True` then variants per each resolution filter is returned. e.g. [webp, jpg, png] If none are specified - it means any/all format
all	10	AllMatch	oneof `resolution`	Returns image variants with any resolution
max	11	MaxMatch	oneof `resolution`	Returns the image variant with highest resolution requested
fit_out	12	FitResolution	oneof `resolution`	Returns the image variant with the smallest resolution that is equal or greater then the provided size.
fit_in	13	FitResolution	oneof `resolution`	Returns the image variant with the gratest resolution that is equal or less then the provided size.

MaxMatch

No fields.

MinMatch

No fields.

ModelGenInfo

Field	Number	Type	Label	Description
weight_dtype	1	voplica.types.ai.common.DType
weight_quant_type	2	voplica.types.ai.common.QuantizationType
model_file_structure	3	voplica.types.ai.common.ModelFileStructure
role	4	voplica.types.ai.common.ModelFileRole
component_name	5	`string`		The diffusers slot this file fills (“transformer”, “transformer_2”, “vae”, “text_encoder”, “text_encoder_2”); empty when unknown. Declared via ConvertParamType.MODEL_GEN_COMPONENT_NAME, re-learned by verification.
measured_footprint	6	ModelResidentFootprint	optional

ModelGenVariantFilter

Field	Number	Type	Label	Description
all	10	AllMatch	oneof `file_size`	Returns generative model variants with any file size
max	11	MaxMatch	oneof `file_size`	Returns the generative model variant with biggest file size
min	12	MinMatch	oneof `file_size`	Returns the generative model variant with smallest file size

ModelResidentFootprint

Field	Number	Type	Description
resident_bytes	1	`uint64`
loaded_dtype	2	voplica.types.ai.common.DType	The dtype the loader MATERIALISED the primary weights at for this measurement. A planner compares like with like: an fp8-loaded measurement says nothing about a bf16 load.
loaded_quant_type	3	voplica.types.ai.common.QuantizationType
weight_tier_label	4	`string`

NoOpFilter

This filter means - no any special filtration logic (i.e. return all files)

No fields.

ObjectInfo

No fields.

SkipAllFilter

This filter means - to filter out all files (i.e. return no files)

No fields.

VectorGraphicInfo

Field	Number	Type	Label	Description
width	1	`uint32`	optional	Viewbox / artboard dimensions if available (e.g. from SVG viewBox or EPS bounding box)
height	2	`uint32`	optional

VectorGraphicVariantFilter

Field	Number	Type	Label	Description
formats	1	voplica.types.base.MimeType	repeated	First ordered format has higher preference over the next format. e.g. [svg, eps, pdf] If none are specified - it means any/all format

VideoInfo

Field	Number	Type	Label
width	1	`uint32`
height	2	`uint32`
codec	3	voplica.types.file.codec.VideoCodecType
profile	4	voplica.types.file.codec.profile.VideoCodecProfileType
level	5	voplica.types.file.codec.profile.VideoCodecLevelType
length_ms	6	`uint64`
bit_rate	7	`uint64`
fps	8	`double`
audio	9	AudioInfo	optional

VideoVariantFilter

Field	Number	Type	Label	Description
codecs	1	voplica.types.file.codec.VideoCodecType	repeated	First ordered codec has higher preference over the next codec. If `all_matches == False` then additional codecs are used as fallback codecs. If `all_matches == True` then variants per each resolution filter is returned. e.g. [VIDEO_CODEC_AV1, VIDEO_CODEC_VP9, VIDEO_CODEC_H265, VIDEO_CODEC_H264] If none are specified - it means any/all codec
all	10	AllMatch	oneof `resolution`	Returns image variants with any resolution
max	11	MaxMatch	oneof `resolution`	Returns the image variant with highest resolution requested
fit_out	12	FitResolution	oneof `resolution`	Returns the image variant with the smallest resolution that is equal or greater then the provided size.
fit_in	13	FitResolution	oneof `resolution`	Returns the image variant with the gratest resolution that is equal or less then the provided size.

VoiceReferenceAudioFileReference

Field	Number	Type	Description
voice_id	1	`string`	ID of the voice the reference audio belongs to.
asset_id	2	`string`	Must equal that voice’s `reference_audio_asset_id`.
file_ref	3	FileReferenceFromFileVariantGroup	File reference that is part of that asset (a DERIVED file of one of the asset’s groups).