github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-07-08 14:05:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Slightly modified the docstring in BasePromptTemplate and StringPromptTemplate. (#1755)

Browse Source 
Regarding [this
issue](https://github.com/hwchase17/langchain/issues/1754),
`BasePromptTample` class docstring is a little outdated, thus it
requires new method `format_prompt` for now.

As such, I have made some modifications to the docstring to bring it up
to date.

I tried to adhere to the established document style, and would
appreciate you for taking a look at this PR.
This commit is contained in:
hitoshi44 2023-03-20 01:47:37 +09:00 committed by GitHub
parent 779790167e
commit e635c86145
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
langchain/prompts/base.py
View File

@ -72,7 +72,7 @@ class StringPromptValue(PromptValue):
class BasePromptTemplate(BaseModel, ABC): 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] input_variables: List[str]
"""A list of the names of the variables the prompt template expects.""" """A list of the names of the variables the prompt template expects."""
@ -196,6 +196,8 @@ class BasePromptTemplate(BaseModel, ABC):
class StringPromptTemplate(BasePromptTemplate, ABC): class StringPromptTemplate(BasePromptTemplate, ABC):
"""String prompt should expose the format method, returning a prompt."""
def format_prompt(self, **kwargs: Any) -> PromptValue: def format_prompt(self, **kwargs: Any) -> PromptValue:
"""Create Chat Messages.""" """Create Chat Messages."""
return StringPromptValue(text=self.format(**kwargs)) return StringPromptValue(text=self.format(**kwargs))