ChatPromptTemplate for conversations in LangChain - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a ChatPromptTemplate in LangChain?

A ChatPromptTemplate is a way to create structured prompts for chat-based language models. It helps organize messages and variables for smooth conversations.

beginner

How do you define variables in a ChatPromptTemplate?

You define variables by specifying placeholders in the template messages. These placeholders get replaced with actual values when the prompt runs.

intermediate

What types of messages can you include in a ChatPromptTemplate?

You can include system messages, human messages, and AI messages. Each type helps guide the conversation flow and model behavior.

intermediate

Why use ChatPromptTemplate instead of plain strings for chat prompts?

It helps keep prompts organized, reusable, and easier to maintain. It also supports dynamic content by filling in variables, making conversations flexible.

advanced

How does ChatPromptTemplate improve conversation management in LangChain?

It structures messages clearly, supports variable substitution, and separates roles like system and user. This makes conversations predictable and easier to control.

What role does a system message play in a ChatPromptTemplate?

A It sets the behavior or context for the AI.

B It is the user's input message.

C It is the AI's response message.

D It stores variables for the prompt.

System messages provide instructions or context to guide the AI's responses.

How do you insert dynamic content into a ChatPromptTemplate?

A By using only static strings.

B By hardcoding all text in the template.

C By editing the AI's code directly.

D By using placeholders like {variable} in the template.

Placeholders allow you to insert values dynamically when generating the prompt.

Which message type represents the AI's reply in a ChatPromptTemplate?

A SystemMessage

B AIMessage

C HumanMessage

D UserMessage

AIMessage is used to represent the AI's responses in the conversation.

What is a key advantage of using ChatPromptTemplate in LangChain?

A It organizes conversation prompts with variables and roles.

B It replaces the need for AI models.

C It automatically trains the AI model.

D It disables user input.

ChatPromptTemplate helps organize prompts clearly with roles and dynamic variables.

Can ChatPromptTemplate handle multiple messages in one prompt?

A No, only one message is allowed.

B Only AI messages are allowed.

C Yes, it can include multiple messages with different roles.

D Only system messages are allowed.

ChatPromptTemplate supports multiple messages like system, human, and AI messages in one prompt.

Explain how ChatPromptTemplate helps manage conversations in LangChain.

Think about how it organizes messages and inserts dynamic content.

Describe the difference between system, human, and AI messages in a ChatPromptTemplate.

Consider who is speaking or controlling the message.

Practice

1. What is the main purpose of ChatPromptTemplate in Langchain conversations?

easy

A. To organize chat messages with placeholders for dynamic inputs

B. To execute database queries automatically

C. To style chat messages with CSS

D. To store user credentials securely

Solution

1. Step 1: Understand ChatPromptTemplate role

   ChatPromptTemplate helps structure chat messages and insert dynamic user inputs using placeholders.

2. Step 2: Eliminate unrelated options

   Options about database queries, styling, or security are unrelated to ChatPromptTemplate's purpose.

3. Final Answer:

   To organize chat messages with placeholders for dynamic inputs -> Option A

4. Quick Check:

   ChatPromptTemplate = Organize messages + placeholders [OK]

Hint: ChatPromptTemplate structures chat with placeholders [OK]

Common Mistakes:

• Confusing ChatPromptTemplate with styling or security features
• Thinking it runs queries or handles authentication

2. Which of the following is the correct way to create a ChatPromptTemplate with a user input placeholder named 'name'?

easy

A. ChatPromptTemplate.from_template('Hello {name}!')

B. ChatPromptTemplate('Hello $name!')

C. ChatPromptTemplate.create('Hello {{name}}!')

D. ChatPromptTemplate.new('Hello %name%!')

Solution

1. Step 1: Recall correct placeholder syntax

   Langchain uses curly braces {name} inside from_template method to define placeholders.

2. Step 2: Check method and syntax correctness

   Only ChatPromptTemplate.from_template('Hello {name}!') uses from_template and correct {name} placeholder syntax.

3. Final Answer:

   ChatPromptTemplate.from_template('Hello {name}!') -> Option A

4. Quick Check:

   Use from_template with {placeholder} [OK]

Hint: Use from_template and {placeholder} syntax [OK]

Common Mistakes:

• Using wrong placeholder symbols like $ or % or double braces
• Using non-existent methods like create or new

3. Given this code snippet:

from langchain.prompts import ChatPromptTemplate

prompt = ChatPromptTemplate.from_template('Hi {user}! How can I help you today?')
message = prompt.format_prompt(user='Alice').to_messages()
print(message[0].content)

What will be printed?

medium

A. Hi {user}! How can I help you today?

B. Hi Alice! How can I help you today?

C. Hi ! How can I help you today?

D. Error: format_prompt missing argument

Solution

1. Step 1: Understand placeholder replacement

   The placeholder {user} is replaced by the value 'Alice' passed to format_prompt.

2. Step 2: Check printed message content

   message[0].content contains the formatted string with 'Alice' inserted.

3. Final Answer:

   Hi Alice! How can I help you today? -> Option B

4. Quick Check:

   Placeholder replaced with 'Alice' in output [OK]

Hint: format_prompt replaces placeholders with given values [OK]

Common Mistakes:

• Thinking placeholders remain unreplaced in output
• Assuming missing argument error without passing user
• Confusing message object with string directly

4. What is wrong with this code snippet?

from langchain.prompts import ChatPromptTemplate

prompt = ChatPromptTemplate.from_template('Hello {name}!')
message = prompt.format_prompt().to_messages()

medium

A. Placeholder syntax should use $name instead of {name}

B. Incorrect method name 'from_template'

C. Missing argument for placeholder 'name' in format_prompt

D. to_messages() is not a valid method

Solution

1. Step 1: Identify placeholder usage

   The template has a placeholder {name} that requires a value when formatting.

2. Step 2: Check format_prompt call

   format_prompt() is called without providing the required 'name' argument, causing an error.

3. Final Answer:

   Missing argument for placeholder 'name' in format_prompt -> Option C

4. Quick Check:

   Placeholder needs matching argument in format_prompt [OK]

Hint: Always pass all placeholders to format_prompt [OK]

Common Mistakes:

• Forgetting to pass required placeholder arguments
• Thinking method names or syntax are incorrect
• Assuming to_messages() doesn't exist

5. You want to create a conversation prompt that greets the user by name and asks their favorite color, then stores both inputs dynamically. Which approach using ChatPromptTemplate is correct?

hard

A. Use a template 'Hello {name}! What is your favorite color?' and call format_prompt(name='Bob') only

B. Use two separate ChatPromptTemplates, one for name and one for color, then combine messages manually

C. Use a template 'Hello $name, favorite color $color?' and call format_prompt(name='Bob', color='blue')

D. Use a template like 'Hello {name}, what is your favorite color {color}?' and call format_prompt(name='Bob', color='blue')

Solution

1. Step 1: Understand placeholder usage for multiple inputs

   ChatPromptTemplate supports multiple placeholders in one template string, e.g., {name} and {color}.

2. Step 2: Check correct syntax and method usage

   Use a template like 'Hello {name}, what is your favorite color {color}?' and call format_prompt(name='Bob', color='blue') uses correct curly brace placeholders and passes both arguments in format_prompt.

3. Step 3: Evaluate other options

   Use two separate ChatPromptTemplates, one for name and one for color, then combine messages manually is more complex than needed; Use a template 'Hello {name}! What is your favorite color?' and call format_prompt(name='Bob') only misses the color input; Use a template 'Hello $name, favorite color $color?' and call format_prompt(name='Bob', color='blue') uses wrong placeholder syntax.

4. Final Answer:

   Use a template like 'Hello {name}, what is your favorite color {color}?' and call format_prompt(name='Bob', color='blue') -> Option D

5. Quick Check:

   Multiple placeholders with format_prompt arguments [OK]

Hint: Use {placeholder} for each input and pass all in format_prompt [OK]

Common Mistakes:

• Using wrong placeholder syntax like $name
• Splitting conversation unnecessarily into multiple templates
• Not passing all required inputs to format_prompt