Artifact Versions - TrueFoundry Docs

apply_tags

Apply tags to an artifact version.

Parameters

str

required

ID of the artifact version to apply tags to

typing.Sequence[str]

required

List of tags to apply to the artifact version

typing.Optional[bool]

Whether to overwrite existing tags if they conflict

Returns

EmptyResponse

🔗 EmptyResponseEmpty response indicating successful tag application

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.artifact_versions.apply_tags(
    artifact_version_id="value",
    tags="value",
    force="value",
)

get

Get an artifact version by its ID.

Parameters

str

required

Returns

GetArtifactVersionResponse

🔗 GetArtifactVersionResponseThe artifact version data

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.artifact_versions.get(
    id="id_value",
)

delete

Delete an artifact version by its ID.

Parameters

str

required

Returns

EmptyResponse

🔗 EmptyResponseEmpty response indicating successful deletion

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.artifact_versions.delete(
    id="id_value",
)

list

List artifact versions with optional filtering by tag, FQN, artifact ID, ML Repo, name, version, run IDs, or run steps.

Parameters

typing.Optional[str]

Tag to filter artifact versions by

typing.Optional[str]

Fully qualified name to filter artifact versions by (format: ’://’ or ’://:’)

typing.Optional[str]

ID of the artifact to filter versions by

typing.Optional[str]

ID of the ML Repo to filter artifact versions by

typing.Optional[str]

Name of the artifact to filter versions by

typing.Optional[int]

Version number (positive integer) or ‘latest’ to filter by specific version

typing.Optional[typing.Union[str, typing.Sequence[str]]]

List of run IDs to filter artifact versions by

typing.Optional[typing.Union[int, typing.Sequence[int]]]

List of run step numbers to filter artifact versions by

typing.Optional[int]

Number of artifact versions to skip for pagination

typing.Optional[int]

Maximum number of artifact versions to return

typing.Optional[bool]

Whether to include internal metadata in the response

Returns

🔗 ListArtifactVersionsResponseList of artifact versions matching the query with pagination information

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.artifact_versions.list(
    tag="value",
    fqn="value",
    artifact_id="value",
    ml_repo_id="value",
    name="value",
    version="value",
    run_ids="value",
    run_steps="value",
    offset=10,
    limit=10,
    include_internal_metadata="value",
)

# Iterate through results
for item in response:
    print(item.name)

# Or paginate page by page
for page in response.iter_pages():
    for item in page:
        print(item.name)

get_signed_urls

Get pre-signed URLs for reading or writing files in an artifact version.

Parameters

str

required

ID of the artifact version to get signed URLs for

typing.Sequence[str]

required

List of relative file paths within the artifact version to get signed URLs for

Operation

required

🔗 OperationOperation type for the signed URL (e.g., ‘READ’ or ‘WRITE’)

Returns

GetSignedUrLsResponse

🔗 GetSignedUrLsResponseList of signed URLs for the requested file paths

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.artifact_versions.get_signed_urls(
    id="id_value",
    paths="value",
    operation="value",
)

create_multi_part_upload

Create a multipart upload for large files in an artifact version.

Parameters

str

required

ID of the artifact version to upload files to

str

required

Relative path within the artifact version where the file should be uploaded

int

required

Number of parts to split the upload into for multipart upload

Returns

MultiPartUploadResponse

🔗 MultiPartUploadResponseMultipart upload information including signed URLs for each part

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.artifact_versions.create_multi_part_upload(
    id="id_value",
    path="value",
    num_parts="value",
)

stage

Stage an artifact version for upload, returning storage location and version ID.

Parameters

StageArtifactRequestManifest

required

🔗 StageArtifactRequestManifestManifest containing metadata for the artifact to be staged (model or generic artifact)

Returns

StageArtifactResponse

🔗 StageArtifactResponseStaging information including version ID, storage root, and artifact ID

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.artifact_versions.stage(
    manifest={"key": "value"},
)

list_files

List files and directories in an artifact version.

Parameters

str

required

ID of the artifact version to list files from

typing.Optional[str]

Relative path within the artifact version to list files from (defaults to root)

typing.Optional[int]

Maximum number of files/directories to return

typing.Optional[str]

Token to retrieve the next page of results

Returns

🔗 ListFilesResponseList of files and directories with pagination information

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.artifact_versions.list_files(
    id="id_value",
    path="value",
    limit=10,
    page_token="value",
)

mark_stage_failure

Mark a staged artifact version as failed.

Parameters

str

required

ID of the staged artifact version to mark as failed

Returns

EmptyResponse

🔗 EmptyResponseEmpty response indicating successful failure marking

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.artifact_versions.mark_stage_failure(
    id="id_value",
)

get_by_fqn

Get Artifact Version by FQN.

Parameters

str

required

FQN of the artifact version

Returns

GetArtifactVersionResponse

🔗 GetArtifactVersionResponseArtifact version details

Usage

from truefoundry import TrueFoundry

client = TrueFoundry(
    api_key="YOUR_API_KEY",
    base_url="https://yourhost.com/path/to/api",
)

client.artifact_versions.get_by_fqn(
    fqn="value",
)

​Methods

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

Methods

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage