Truefoundry Docs

get

Get a data directory by its ID.

Parameters

id

str

required

Returns

GetDataDirectoryResponse

🔗 GetDataDirectoryResponseSuccessful Response

Usage

from truefoundry import TrueFoundry

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

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

delete

Delete a data directory and optionally its contents.

Parameters

id

str

required

delete_contents

typing.Optional[bool]

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.data_directories.delete(
    id="id_value",
    delete_contents="value",
)

list

List all data directories with optional filtering and pagination.

Parameters

fqn

typing.Optional[str]

ml_repo_id

typing.Optional[str]

name

typing.Optional[str]

limit

typing.Optional[int]

offset

typing.Optional[int]

Returns

🔗 DataDirectorySuccessful Response

Usage

from truefoundry import TrueFoundry

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

client.data_directories.list(
    fqn="value",
    ml_repo_id="value",
    name="value",
    limit=10,
    offset=10,
)

# 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)

create_or_update

Parameters

manifest

DataDirectoryManifest

required

🔗 DataDirectoryManifest

Returns

GetDataDirectoryResponse

🔗 GetDataDirectoryResponseSuccessful Response

Usage

from truefoundry import TrueFoundry

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

client.data_directories.create_or_update(
    manifest={"key": "value"},
)

list_files

List files in a dataset.

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.data_directories.list_files(
    id="id_value",
    path="value",
    limit=10,
    page_token="value",
)

delete_files

Delete files from the dataset.

Parameters

id

str

required

paths

typing.Sequence[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.data_directories.delete_files(
    id="id_value",
    paths="value",
)

get_signed_urls

Get signed URLs for a dataset.

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.data_directories.get_signed_urls(
    id="id_value",
    paths="value",
    operation="value",
)

create_multipart_upload

Create a multipart upload for a dataset

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.data_directories.create_multipart_upload(
    id="id_value",
    path="value",
    num_parts="value",
)

get_by_fqn

Get Data Directory by FQN.

Parameters

fqn

str

required

FQN of the data directory

Returns

GetDataDirectoryResponse

🔗 GetDataDirectoryResponseData directory details

Usage

from truefoundry import TrueFoundry

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

client.data_directories.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