Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENHANCEMENT]: Change "version" to prompt_content or something slightly more obvious #6748

Open
jlopatec opened this issue Mar 8, 2025 · 0 comments
Labels
backlog enhancement New feature or request

Comments

@jlopatec
Copy link
Collaborator

jlopatec commented Mar 8, 2025

The version input parameter is a bit confusing. I was trying to set an ID.

Before prompts get widely used in SDKs, we might want to change this name.

My expectation with a field like "version" is a string ID not the actual prompt data might want to call it prompt_data

prompt_name = "article-bullet-summarizer"
prompt = Client().prompts.create(
name=prompt_name,
prompt_description="Summarize an article in a few bullet points",
version=PromptVersion(
[{"role": "user", "content": content}],
model_name="gpt-4o-mini",
),
)

Included is o1's take :)
You’re right that using the name “version” can be confusing if it’s not actually referring to a unique version identifier. A clearer name might be something that indicates it contains the actual configuration or content of the prompt—for example, prompt_data, prompt_definition, prompt_content, or simply content. This makes it clear that the field contains the substance or structure of the prompt rather than just a version ID.

@jlopatec jlopatec added enhancement New feature or request triage issues that need triage labels Mar 8, 2025
@github-project-automation github-project-automation bot moved this to 📘 Todo in phoenix Mar 8, 2025
@mikeldking mikeldking added backlog and removed triage issues that need triage labels Mar 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog enhancement New feature or request
Projects
Status: 📘 Todo
Development

No branches or pull requests

2 participants