Model

Description: Represents a model resource that includes associated files, artifacts, jobs, and metadata.

Attributes

Name	Type	Description
id	StrictStr
created	datetime.datetime
file	File
comments	List[Comment]
archive_status_history	List[ResourceArchiveStatus]
created_by_id	StrictStr
artifacts	List[Artifact]
jobs	Optional[List[Job]]
control_tags	Optional[List[ControlTag]]

Methods

Name	Description
add_job	Add a job associated with this model.
to_str	Return the string representation of the model using field aliases.
to_json	Return the JSON string representation of the model using field aliases.
from_json	Create an instance of the model from a JSON string.
to_dict	Return the dictionary representation of the model using field aliases.
from_dict	Create an instance of the model from a dictionary.
update_properties	Update one or more metadata fields on the underlying file.
update_description	Update the file’s description.
update_display_name	Update the file’s display name.
update_external_identifier	Update the file’s external identifier.
update_version_name	Update the file’s version name.
read_bytes	Read and return the raw byte contents of the associated file revision.
read_text	Read the contents as decoded text.
copy_to	Copy the contents to a local file.
read_json	Parse the contents as JSON.
cleanup_cache	Clean up cached files if they exist.
get_cache_stats	Get filesystem cache statistics.
create_access	Create a new access relationship for a subject by ID.
create_access_by_email	Create a new access relationship for a subject by email.
update_access	Update an existing access relationship for a subject.
remove_access	Remove an existing access relationship.
list_access	List all access relationships for this resource.
archive	Archive the current item using the client’s archive method for this resource type.
restore	Restore the current item using the client’s restore method for this resource type.