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

PromptTemplate documentation mentions renamed prompt_text parameter #5179

Closed
julian-risch opened this issue Jun 21, 2023 · 1 comment
Closed
Assignees
Labels
P1 High priority, add to the next sprint topic:promptnode type:documentation Improvements on the docs

Comments

@julian-risch
Copy link
Member

julian-risch commented Jun 21, 2023

PR #4879 renamed PromptTemplate input parameters but the documentation page of PromptNode shows an example with the old parameter name. We need to update the example.

We need to rename prompt_text to prompt and name="lfqa", can be removed completely in the example: https://docs.haystack.deepset.ai/v1.18-unstable/docs/prompt_node#long-form-question-answering
Here is the new implementation of PromptTemplate:
https://github.com/deepset-ai/haystack/blob/main/haystack/nodes/prompt/prompt_template.py#L367

https://docs.haystack.deepset.ai/v1.18-unstable/docs/prompt_node#prompttemplate-structure needs to be updated accordingly too: We need to rename prompt_text to prompt and name="...", can be removed completely

@bogdankostic bogdankostic added the P1 High priority, add to the next sprint label Jun 21, 2023
@dfokina dfokina closed this as completed Jun 22, 2023
@dfokina
Copy link
Contributor

dfokina commented Jun 22, 2023

Done, doc cleaned up :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1 High priority, add to the next sprint topic:promptnode type:documentation Improvements on the docs
Projects
None yet
Development

No branches or pull requests

3 participants