mirror of https://github.com/hwchase17/langchain
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
300 lines
9.5 KiB
Python
300 lines
9.5 KiB
Python
2 years ago
|
"""Test functionality related to prompts."""
|
||
|
import pytest
|
||
|
|
||
10 months ago
|
from langchain_core.prompts.prompt import PromptTemplate
|
||
2 years ago
|
|
||
|
|
||
|
def test_prompt_valid() -> None:
|
||
|
"""Test prompts can be constructed."""
|
||
|
template = "This is a {foo} test."
|
||
|
input_variables = ["foo"]
|
||
2 years ago
|
prompt = PromptTemplate(input_variables=input_variables, template=template)
|
||
2 years ago
|
assert prompt.template == template
|
||
|
assert prompt.input_variables == input_variables
|
||
|
|
||
|
|
||
2 years ago
|
def test_prompt_from_template() -> None:
|
||
|
"""Test prompts can be constructed from a template."""
|
||
|
# Single input variable.
|
||
|
template = "This is a {foo} test."
|
||
|
prompt = PromptTemplate.from_template(template)
|
||
|
expected_prompt = PromptTemplate(template=template, input_variables=["foo"])
|
||
|
assert prompt == expected_prompt
|
||
|
|
||
|
# Multiple input variables.
|
||
|
template = "This {bar} is a {foo} test."
|
||
|
prompt = PromptTemplate.from_template(template)
|
||
|
expected_prompt = PromptTemplate(template=template, input_variables=["bar", "foo"])
|
||
|
assert prompt == expected_prompt
|
||
|
|
||
|
# Multiple input variables with repeats.
|
||
|
template = "This {bar} is a {foo} test {foo}."
|
||
|
prompt = PromptTemplate.from_template(template)
|
||
|
expected_prompt = PromptTemplate(template=template, input_variables=["bar", "foo"])
|
||
|
assert prompt == expected_prompt
|
||
|
|
||
|
|
||
2 years ago
|
def test_prompt_missing_input_variables() -> None:
|
||
|
"""Test error is raised when input variables are not provided."""
|
||
|
template = "This is a {foo} test."
|
||
|
input_variables: list = []
|
||
|
with pytest.raises(ValueError):
|
||
11 months ago
|
PromptTemplate(
|
||
|
input_variables=input_variables, template=template, validate_template=True
|
||
|
)
|
||
|
assert PromptTemplate(
|
||
|
input_variables=input_variables, template=template
|
||
|
).input_variables == ["foo"]
|
||
2 years ago
|
|
||
|
|
||
|
def test_prompt_extra_input_variables() -> None:
|
||
|
"""Test error is raised when there are too many input variables."""
|
||
|
template = "This is a {foo} test."
|
||
|
input_variables = ["foo", "bar"]
|
||
|
with pytest.raises(ValueError):
|
||
11 months ago
|
PromptTemplate(
|
||
|
input_variables=input_variables, template=template, validate_template=True
|
||
|
)
|
||
|
assert PromptTemplate(
|
||
|
input_variables=input_variables, template=template
|
||
|
).input_variables == ["foo"]
|
||
2 years ago
|
|
||
|
|
||
|
def test_prompt_wrong_input_variables() -> None:
|
||
|
"""Test error is raised when name of input variable is wrong."""
|
||
|
template = "This is a {foo} test."
|
||
|
input_variables = ["bar"]
|
||
|
with pytest.raises(ValueError):
|
||
11 months ago
|
PromptTemplate(
|
||
|
input_variables=input_variables, template=template, validate_template=True
|
||
|
)
|
||
|
assert PromptTemplate(
|
||
|
input_variables=input_variables, template=template
|
||
|
).input_variables == ["foo"]
|
||
2 years ago
|
|
||
|
|
||
2 years ago
|
def test_prompt_from_examples_valid() -> None:
|
||
|
"""Test prompt can be successfully constructed from examples."""
|
||
|
template = """Test Prompt:
|
||
|
|
||
|
Question: who are you?
|
||
|
Answer: foo
|
||
|
|
||
|
Question: what are you?
|
||
|
Answer: bar
|
||
|
|
||
|
Question: {question}
|
||
|
Answer:"""
|
||
|
input_variables = ["question"]
|
||
|
example_separator = "\n\n"
|
||
2 years ago
|
prefix = """Test Prompt:"""
|
||
|
suffix = """Question: {question}\nAnswer:"""
|
||
2 years ago
|
examples = [
|
||
|
"""Question: who are you?\nAnswer: foo""",
|
||
|
"""Question: what are you?\nAnswer: bar""",
|
||
|
]
|
||
2 years ago
|
prompt_from_examples = PromptTemplate.from_examples(
|
||
2 years ago
|
examples,
|
||
|
suffix,
|
||
|
input_variables,
|
||
|
example_separator=example_separator,
|
||
|
prefix=prefix,
|
||
|
)
|
||
2 years ago
|
prompt_from_template = PromptTemplate(
|
||
|
input_variables=input_variables, template=template
|
||
|
)
|
||
2 years ago
|
assert prompt_from_examples.template == prompt_from_template.template
|
||
|
assert prompt_from_examples.input_variables == prompt_from_template.input_variables
|
||
|
|
||
|
|
||
2 years ago
|
def test_prompt_invalid_template_format() -> None:
|
||
|
"""Test initializing a prompt with invalid template format."""
|
||
|
template = "This is a {foo} test."
|
||
|
input_variables = ["foo"]
|
||
|
with pytest.raises(ValueError):
|
||
2 years ago
|
PromptTemplate(
|
||
2 years ago
|
input_variables=input_variables, template=template, template_format="bar"
|
||
|
)
|
||
2 years ago
|
|
||
|
|
||
|
def test_prompt_from_file() -> None:
|
||
|
"""Test prompt can be successfully constructed from a file."""
|
||
|
template_file = "tests/unit_tests/data/prompt_file.txt"
|
||
|
input_variables = ["question"]
|
||
2 years ago
|
prompt = PromptTemplate.from_file(template_file, input_variables)
|
||
2 years ago
|
assert prompt.template == "Question: {question}\nAnswer:"
|
||
2 years ago
|
|
||
|
|
||
|
def test_partial_init_string() -> None:
|
||
|
"""Test prompt can be initialized with partial variables."""
|
||
|
template = "This is a {foo} test."
|
||
|
prompt = PromptTemplate(
|
||
|
input_variables=[], template=template, partial_variables={"foo": 1}
|
||
|
)
|
||
|
assert prompt.template == template
|
||
|
assert prompt.input_variables == []
|
||
|
result = prompt.format()
|
||
|
assert result == "This is a 1 test."
|
||
|
|
||
|
|
||
|
def test_partial_init_func() -> None:
|
||
|
"""Test prompt can be initialized with partial variables."""
|
||
|
template = "This is a {foo} test."
|
||
|
prompt = PromptTemplate(
|
||
|
input_variables=[], template=template, partial_variables={"foo": lambda: 2}
|
||
|
)
|
||
|
assert prompt.template == template
|
||
|
assert prompt.input_variables == []
|
||
|
result = prompt.format()
|
||
|
assert result == "This is a 2 test."
|
||
|
|
||
|
|
||
|
def test_partial() -> None:
|
||
|
"""Test prompt can be partialed."""
|
||
|
template = "This is a {foo} test."
|
||
|
prompt = PromptTemplate(input_variables=["foo"], template=template)
|
||
|
assert prompt.template == template
|
||
|
assert prompt.input_variables == ["foo"]
|
||
|
new_prompt = prompt.partial(foo="3")
|
||
|
new_result = new_prompt.format()
|
||
|
assert new_result == "This is a 3 test."
|
||
|
result = prompt.format(foo="foo")
|
||
|
assert result == "This is a foo test."
|
||
1 year ago
|
|
||
|
|
||
1 year ago
|
@pytest.mark.requires("jinja2")
|
||
1 year ago
|
def test_prompt_from_jinja2_template() -> None:
|
||
|
"""Test prompts can be constructed from a jinja2 template."""
|
||
|
# Empty input variable.
|
||
|
template = """Hello there
|
||
|
There is no variable here {
|
||
|
Will it get confused{ }?
|
||
|
"""
|
||
|
prompt = PromptTemplate.from_template(template, template_format="jinja2")
|
||
|
expected_prompt = PromptTemplate(
|
||
|
template=template, input_variables=[], template_format="jinja2"
|
||
|
)
|
||
|
assert prompt == expected_prompt
|
||
|
|
||
1 year ago
|
|
||
11 months ago
|
@pytest.mark.requires("jinja2")
|
||
|
def test_basic_sandboxing_with_jinja2() -> None:
|
||
|
"""Test basic sandboxing with jinja2."""
|
||
|
import jinja2
|
||
|
|
||
|
template = " {{''.__class__.__bases__[0] }} " # malicious code
|
||
|
prompt = PromptTemplate.from_template(template, template_format="jinja2")
|
||
|
with pytest.raises(jinja2.exceptions.SecurityError):
|
||
|
assert prompt.format() == []
|
||
|
|
||
|
|
||
1 year ago
|
@pytest.mark.requires("jinja2")
|
||
|
def test_prompt_from_jinja2_template_multiple_inputs() -> None:
|
||
|
"""Test with multiple input variables."""
|
||
1 year ago
|
# Multiple input variables.
|
||
|
template = """\
|
||
|
Hello world
|
||
|
|
||
|
Your variable: {{ foo }}
|
||
|
|
||
|
{# This will not get rendered #}
|
||
|
|
||
|
{% if bar %}
|
||
|
You just set bar boolean variable to true
|
||
|
{% endif %}
|
||
|
|
||
|
{% for i in foo_list %}
|
||
|
{{ i }}
|
||
|
{% endfor %}
|
||
|
"""
|
||
|
prompt = PromptTemplate.from_template(template, template_format="jinja2")
|
||
|
expected_prompt = PromptTemplate(
|
||
|
template=template,
|
||
|
input_variables=["bar", "foo", "foo_list"],
|
||
|
template_format="jinja2",
|
||
|
)
|
||
|
|
||
|
assert prompt == expected_prompt
|
||
|
|
||
1 year ago
|
|
||
|
@pytest.mark.requires("jinja2")
|
||
|
def test_prompt_from_jinja2_template_multiple_inputs_with_repeats() -> None:
|
||
|
"""Test with multiple input variables and repeats."""
|
||
1 year ago
|
template = """\
|
||
|
Hello world
|
||
|
|
||
|
Your variable: {{ foo }}
|
||
|
|
||
|
{# This will not get rendered #}
|
||
|
|
||
|
{% if bar %}
|
||
|
You just set bar boolean variable to true
|
||
|
{% endif %}
|
||
|
|
||
|
{% for i in foo_list %}
|
||
|
{{ i }}
|
||
|
{% endfor %}
|
||
|
|
||
|
{% if bar %}
|
||
|
Your variable again: {{ foo }}
|
||
|
{% endif %}
|
||
|
"""
|
||
|
prompt = PromptTemplate.from_template(template, template_format="jinja2")
|
||
|
expected_prompt = PromptTemplate(
|
||
|
template=template,
|
||
|
input_variables=["bar", "foo", "foo_list"],
|
||
|
template_format="jinja2",
|
||
|
)
|
||
|
assert prompt == expected_prompt
|
||
1 year ago
|
|
||
|
|
||
1 year ago
|
@pytest.mark.requires("jinja2")
|
||
1 year ago
|
def test_prompt_jinja2_missing_input_variables() -> None:
|
||
|
"""Test error is raised when input variables are not provided."""
|
||
|
template = "This is a {{ foo }} test."
|
||
|
input_variables: list = []
|
||
1 year ago
|
with pytest.warns(UserWarning):
|
||
1 year ago
|
PromptTemplate(
|
||
11 months ago
|
input_variables=input_variables,
|
||
|
template=template,
|
||
|
template_format="jinja2",
|
||
|
validate_template=True,
|
||
1 year ago
|
)
|
||
11 months ago
|
assert PromptTemplate(
|
||
|
input_variables=input_variables, template=template, template_format="jinja2"
|
||
|
).input_variables == ["foo"]
|
||
1 year ago
|
|
||
|
|
||
1 year ago
|
@pytest.mark.requires("jinja2")
|
||
1 year ago
|
def test_prompt_jinja2_extra_input_variables() -> None:
|
||
|
"""Test error is raised when there are too many input variables."""
|
||
|
template = "This is a {{ foo }} test."
|
||
|
input_variables = ["foo", "bar"]
|
||
1 year ago
|
with pytest.warns(UserWarning):
|
||
1 year ago
|
PromptTemplate(
|
||
11 months ago
|
input_variables=input_variables,
|
||
|
template=template,
|
||
|
template_format="jinja2",
|
||
|
validate_template=True,
|
||
1 year ago
|
)
|
||
11 months ago
|
assert PromptTemplate(
|
||
|
input_variables=input_variables, template=template, template_format="jinja2"
|
||
|
).input_variables == ["foo"]
|
||
1 year ago
|
|
||
|
|
||
1 year ago
|
@pytest.mark.requires("jinja2")
|
||
1 year ago
|
def test_prompt_jinja2_wrong_input_variables() -> None:
|
||
|
"""Test error is raised when name of input variable is wrong."""
|
||
|
template = "This is a {{ foo }} test."
|
||
|
input_variables = ["bar"]
|
||
1 year ago
|
with pytest.warns(UserWarning):
|
||
1 year ago
|
PromptTemplate(
|
||
11 months ago
|
input_variables=input_variables,
|
||
|
template=template,
|
||
|
template_format="jinja2",
|
||
|
validate_template=True,
|
||
1 year ago
|
)
|
||
11 months ago
|
assert PromptTemplate(
|
||
|
input_variables=input_variables, template=template, template_format="jinja2"
|
||
|
).input_variables == ["foo"]
|