Chat completions endpoint in Prompt Engineering / GenAI - ML Experiment: Train & Evaluate

Experiment - Chat completions endpoint

Problem:You want to build a chatbot that gives helpful answers using a chat completions API. The current model sometimes gives irrelevant or repetitive answers.

Current Metrics:User satisfaction score: 65%, Relevance score: 60%, Repetition rate: 30%

Issue:The chatbot output is often repetitive and not very relevant, lowering user satisfaction.

Your Task

Improve the chatbot's answer relevance to at least 80% and reduce repetition rate below 15%, while keeping user satisfaction above 75%.

You can only change the prompt design and API parameters (like temperature, max tokens).

You cannot change the underlying model architecture.

Hint 1

Hint 2

Hint 3

Solution

Prompt Engineering / GenAI

import openai

openai.api_key = 'your-api-key'

response = openai.chat.completions.create(
    model='gpt-4o-mini',
    messages=[
        {"role": "system", "content": "You are a helpful assistant. Avoid repeating yourself and keep answers relevant."},
        {"role": "user", "content": "Explain how photosynthesis works."}
    ],
    temperature=0.3,
    max_tokens=150
)

print(response.choices[0].message.content)

Added a system message to instruct the chatbot to avoid repetition and stay relevant.

Lowered temperature from default (1.0) to 0.3 to reduce randomness.

Set max_tokens to 150 to keep answers concise.

Results Interpretation

Before: User satisfaction 65%, Relevance 60%, Repetition 30%
After: User satisfaction 78%, Relevance 82%, Repetition 12%

Adjusting prompt instructions and API parameters like temperature can significantly improve chatbot answer quality without changing the model.

Bonus Experiment

Try adding user context or conversation history to the messages to see if the chatbot gives even more relevant answers.

💡 Hint

Include previous user and assistant messages in the 'messages' list to provide context.

Practice

1. What is the main purpose of the chat completions endpoint in GenAI?

easy

A. To send messages and receive AI-generated replies in a conversation format

B. To train a new AI model from scratch

C. To upload datasets for AI training

D. To visualize AI model architecture

Solution

1. Step 1: Understand the endpoint's function

   The chat completions endpoint is designed to handle conversations by sending messages and getting AI replies.

2. Step 2: Compare options with the endpoint's purpose

   Only To send messages and receive AI-generated replies in a conversation format describes sending messages and receiving replies, which matches the chat completions endpoint.

3. Final Answer:

   To send messages and receive AI-generated replies in a conversation format -> Option A

4. Quick Check:

   Chat completions endpoint = conversation replies [OK]

Hint: Chat completions = chat messages in, AI replies out [OK]

Common Mistakes:

• Confusing chat completions with model training
• Thinking it uploads data instead of chatting
• Assuming it visualizes model details

2. Which of the following is the correct way to format messages sent to the chat completions endpoint?

easy

A. [{"content": "Hello!"}, {"content": "Hi! How can I help?"}]

B. ["Hello!", "Hi! How can I help?"]

C. {"user": "Hello!", "assistant": "Hi! How can I help?"}

D. [{"role": "user", "content": "Hello!"}, {"role": "assistant", "content": "Hi! How can I help?"}]

Solution

1. Step 1: Recall message format requirements

   The chat completions endpoint expects a list of messages, each with a role and content.

2. Step 2: Match options to the required format

   [{"role": "user", "content": "Hello!"}, {"role": "assistant", "content": "Hi! How can I help?"}] correctly uses a list of dictionaries with "role" and "content" keys, matching the expected format.

3. Final Answer:

   [{"role": "user", "content": "Hello!"}, {"role": "assistant", "content": "Hi! How can I help?"}] -> Option D

4. Quick Check:

   Messages need role and content keys [OK]

Hint: Messages need both role and content keys [OK]

Common Mistakes:

• Sending messages as plain strings without roles
• Using incorrect JSON object structure
• Omitting the role field in messages

3. Given this code snippet using the chat completions endpoint, what will be the output's role and content?

messages = [{"role": "user", "content": "What's the weather?"}]
response = chat_completions(messages=messages, temperature=0.5)
print(response.choices[0].message)

medium

A. {"role": "system", "content": "Weather info not available."}

B. {"role": "user", "content": "What's the weather?"}

C. {"role": "assistant", "content": "I don't have weather data."}

D. An error because temperature is invalid

Solution

1. Step 1: Understand the response structure

   The chat completions endpoint returns a response with choices, each containing a message with role and content.

2. Step 2: Identify the role of the returned message

   The returned message role is "assistant" because the AI replies to the user message.

3. Final Answer:

   {"role": "assistant", "content": "I don't have weather data."} -> Option C

4. Quick Check:

   Response role = assistant, content = AI reply [OK]

Hint: AI replies have role 'assistant' in response [OK]

Common Mistakes:

• Confusing user message with AI reply
• Expecting system role in output
• Thinking temperature causes error here

4. You wrote this code but get an error:

messages = [{"content": "Hello!"}]
response = chat_completions(messages=messages)
print(response.choices[0].message)

What is the likely cause of the error?

medium

A. The messages list should be a string, not a list

B. Missing the 'role' key in the message dictionary

C. The chat_completions function requires a 'temperature' argument

D. The print statement syntax is incorrect

Solution

1. Step 1: Check message format requirements

   Each message must have both 'role' and 'content' keys to be valid.

2. Step 2: Identify missing key in the code

   The message dictionary only has 'content' but lacks the required 'role' key, causing the error.

3. Final Answer:

   Missing the 'role' key in the message dictionary -> Option B

4. Quick Check:

   Every message needs role and content keys [OK]

Hint: Always include 'role' in each message dictionary [OK]

Common Mistakes:

• Assuming temperature is mandatory
• Thinking messages should be a string
• Blaming print statement syntax

5. You want the AI to give more creative and varied answers using the chat completions endpoint. Which parameter should you adjust and how?

hard

A. Increase the temperature value closer to 1 to make responses more creative

B. Decrease the max_tokens to limit response length

C. Set temperature to 0 to get random answers

D. Remove the messages parameter to let AI decide context

Solution

1. Step 1: Understand the role of temperature

   The temperature parameter controls randomness; higher values produce more creative and varied outputs.

2. Step 2: Choose the correct adjustment for creativity

   Increasing temperature closer to 1 encourages creativity, while 0 makes responses deterministic.

3. Final Answer:

   Increase the temperature value closer to 1 to make responses more creative -> Option A

4. Quick Check:

   Higher temperature = more creative answers [OK]

Hint: Higher temperature means more creative AI replies [OK]

Common Mistakes:

• Setting temperature to 0 expecting creativity
• Confusing max_tokens with creativity control
• Removing messages causes loss of context