Truefoundry Docs

get

Get artifact version API

Parameters

id

str

required

Returns

GetArtifactVersionResponse

🔗 GetArtifactVersionResponseSuccessful Response

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 artifact versions API

Parameters

id

str

required

Returns

EmptyResponse

🔗 EmptyResponseSuccessful Response

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 version API

Parameters

fqn

typing.Optional[str]

artifact_id

typing.Optional[str]

ml_repo_id

typing.Optional[str]

name

typing.Optional[str]

version

typing.Optional[int]

run_ids

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

run_steps

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

offset

typing.Optional[int]

limit

typing.Optional[int]

include_internal_metadata

typing.Optional[bool]

Returns

🔗 ArtifactVersionSuccessful Response

Usage

from truefoundry import TrueFoundry

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

client.artifact_versions.list(
    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

Parameters

id

str

required

paths

typing.Sequence[str]

required

operation

Operation

required

🔗 Operation

Returns

GetSignedUrLsResponse

🔗 GetSignedUrLsResponseSuccessful Response

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

Parameters

id

str

required

path

str

required

num_parts

int

required

Returns

MultiPartUploadResponse

🔗 MultiPartUploadResponseSuccessful Response

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

Parameters

manifest

StageArtifactRequestManifest

required

🔗 StageArtifactRequestManifest

Returns

StageArtifactResponse

🔗 StageArtifactResponseSuccessful Response

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

Parameters

id

str

required

path

typing.Optional[str]

limit

typing.Optional[int]

page_token

typing.Optional[str]

Returns

🔗 FileInfoSuccessful Response

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

Parameters

id

str

required

Returns

EmptyResponse

🔗 EmptyResponseSuccessful Response

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

fqn

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",
)

TrueFoundry SDK

Clusters

Workspaces

MLRepos

Applications

Jobs

Models

Artifacts

Prompts

Secret Groups

Secrets

Model Deployments

Users

Teams

Personal Access Tokens

Virtual Accounts

Logs

Audit Logs

Apply

​Methods

Methods