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

Slightly modified the docstring in BasePromptTemplate and StringPromptTemplate. #1755

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion langchain/prompts/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ def to_messages(self) -> List[BaseMessage]:


class BasePromptTemplate(BaseModel, ABC):
"""Base prompt should expose the format method, returning a prompt."""
"""Base class for all prompt templates, returning a prompt."""

input_variables: List[str]
"""A list of the names of the variables the prompt template expects."""
Expand Down Expand Up @@ -196,6 +196,8 @@ def save(self, file_path: Union[Path, str]) -> None:


class StringPromptTemplate(BasePromptTemplate, ABC):
"""String prompt should expose the format method, returning a prompt."""

def format_prompt(self, **kwargs: Any) -> PromptValue:
"""Create Chat Messages."""
return StringPromptValue(text=self.format(**kwargs))