Prompt Versions

SDK methods to list, fetch, tag, and manage versions of prompts stored in TrueFoundry.

Methods

apply_tags

Apply tags to a prompt version.

Parameters

prompt_version_id · str · required

ID of the prompt version to apply tags to

tags · typing.Sequence[str] · required

List of tags to apply to the prompt version

force · typing.Optional[bool]

Whether to overwrite existing tags if they conflict

Returns

EmptyResponse · EmptyResponse

🔗 EmptyResponse

Empty 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.prompt_versions.apply_tags(
    prompt_version_id="value",
    tags="value",
    force="value",
)

get

Get a prompt version by its ID.

Parameters

id · str · required

Returns

GetPromptVersionResponse · GetPromptVersionResponse

🔗 GetPromptVersionResponse

The prompt version data

Usage

from truefoundry import TrueFoundry

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

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

delete

Delete a prompt version by its ID.

Parameters

id · str · required

Returns

EmptyResponse · EmptyResponse

🔗 EmptyResponse

Empty 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.prompt_versions.delete(
    id="id_value",
)

list

List prompt versions with optional filtering by tag, FQN, prompt ID, ML Repo, name, or version.

Parameters

tag · typing.Optional[str]

Tag to filter prompt versions by

fqn · typing.Optional[str]

Fully qualified name to filter prompt versions by (format: ‘chat_prompt://’ or ‘chat_prompt://:’)

prompt_id · typing.Optional[str]

ID of the prompt to filter versions by

ml_repo_id · typing.Optional[str]

ID of the ML Repo to filter prompt versions by

name · typing.Optional[str]

Name of the prompt to filter versions by

version · typing.Optional[int]

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

offset · typing.Optional[int]

Number of prompt versions to skip for pagination

limit · typing.Optional[int]

Maximum number of prompt versions to return

Returns

SyncPager[PromptVersion, ListPromptVersionsResponse] · SyncPager[PromptVersion, ListPromptVersionsResponse]

🔗 ListPromptVersionsResponse

List of prompt 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.prompt_versions.list(
    tag="value",
    fqn="value",
    prompt_id="value",
    ml_repo_id="value",
    name="value",
    version="value",
    offset=10,
    limit=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)

get_by_fqn

Get Prompt Version by FQN.

Parameters

fqn · str · required

FQN of the prompt version

Returns

GetPromptVersionResponse · GetPromptVersionResponse

🔗 GetPromptVersionResponse

Prompt version details

Usage

from truefoundry import TrueFoundry

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

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