PromptTemplatesResource

PromptTemplatesResource ¶

PromptTemplatesResource(client: Client)

Bases: BaseResource

delete ¶

delete(prompt_template: PromptTemplate) -> None

Deletes a prompt template.

Parameters:

Name	Type	Description	Default
`prompt_template`	`PromptTemplate`	The prompt template to delete.	required

Raises:

Type	Description
`HTTPStatusError`	If the prompt template doesn't exist or belongs to a different project.

get ¶

get(name: str, version: int | Literal['latest'] = 'latest') -> PromptTemplate

Get a prompt template by name and version.

Parameters:

Name	Type	Description	Default
`name`	`str`	Name of the prompt template.	required
`version`	`int \| Literal['latest']`	Version number or "latest". Defaults to "latest".	`'latest'`

Returns:

Type	Description
`PromptTemplate`	The requested prompt template.

Raises:

Type	Description
`ValueError`	If no template is found with given name and version.

get_or_create ¶

get_or_create(user_prompt_template: str, name: str, parent_prompt_template: PromptTemplate | None = None, default_collection: TemplateVariablesCollection | None = None) -> tuple[PromptTemplate, bool]

Gets the prompt template by its name and user prompt contents if it exists. If the prompt template name does not exist, it creates a new prompt template with version 1. If a prompt template with the same name exists, but the user prompt is new, then it creates a new prompt template version with the new user prompt which will be the new latest version. When a prompt template with the same name and user prompt already exists, it returns the existing prompt template, ignoring the given parent_prompt_template, default_collection

Parameters:

Name	Type	Description	Default
`user_prompt_template`	`str`	The template string containing variables in {{variable}} format.	required
`name`	`str`	Name for the template.	required
`parent_prompt_template`	`PromptTemplate \| None`	Optional parent template to inherit from.	`None`
`default_collection`	`TemplateVariablesCollection \| None`	Optional default template variables collection.	`None`

Returns:

Type	Description
`tuple[PromptTemplate, bool]`	tuple[PromptTemplate, bool]: A tuple containing: - The prompt template - Boolean indicating if a new template was created (True) or existing one returned (False)

Raises:

Type	Description
`ValueError`	If a 409 response is received without a prompt_template_id.

list ¶

list(name: str | None = None, default_collection: TemplateVariablesCollection | None = None, criterion_set: CriterionSet | None = None, compatible_collection: TemplateVariablesCollection | None = None) -> list[PromptTemplate]

Get a list of prompt templates.

Parameters:

Name	Type	Description	Default
`name`	`str \| None`	Name of the prompt template to filter by.	`None`
`default_collection`	`TemplateVariablesCollection \| None`	Default template variables collection to filter by.	`None`
`criterion_set`	`CriterionSet \| None`	Criterion set to filter by.	`None`
`compatible_collection`	`TemplateVariablesCollection \| None`	Compatible template variables collection to filter by.	`None`

Returns:

Type	Description
`list[PromptTemplate]`	list[PromptTemplate]: A list of prompt templates.