Skip to main content

Methods

Get prompt version API

Parameters

id
str
required

Returns

GetPromptVersionResponse
GetPromptVersionResponse

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

Parameters

id
str
required

Returns

EmptyResponse
EmptyResponse
🔗 EmptyResponseSuccessful Response

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

Parameters

fqn
typing.Optional[str]
prompt_id
typing.Optional[str]
ml_repo_id
typing.Optional[str]
name
typing.Optional[str]
version
typing.Optional[int]
offset
typing.Optional[int]
limit
typing.Optional[int]

Returns

SyncPager[PromptVersion]
SyncPager[PromptVersion]
🔗 PromptVersionSuccessful Response

Usage

from truefoundry import TrueFoundry

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

client.prompt_versions.list(
    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 Prompt Version by FQN.

Parameters

fqn
str
required
FQN of the prompt version

Returns

GetPromptVersionResponse
GetPromptVersionResponse
🔗 GetPromptVersionResponsePrompt 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",
)
I