Chat completions endpoint in Prompt Engineering / GenAI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the Chat completions endpoint in generative AI?

It generates conversational responses based on the input messages, allowing AI to chat naturally with users.

beginner

What kind of input does the Chat completions endpoint expect?

It expects a list of messages, each with a role (like 'user' or 'assistant') and content (the text to process).

beginner

How does the Chat completions endpoint return its output?

It returns a completion object containing the AI's reply message, usually with the role 'assistant' and the generated text.

intermediate

Why is specifying the 'model' important when calling the Chat completions endpoint?

Because different models have different capabilities and sizes, choosing the right one affects response quality and speed.

beginner

What is a common use case for the Chat completions endpoint?

Building chatbots, virtual assistants, or any application that needs natural, conversational AI responses.

What role is typically assigned to the AI's response in the Chat completions endpoint?

A moderator

B user

C system

D assistant

The AI's replies are labeled with the role 'assistant' to distinguish them from user or system messages.

Which of the following is NOT part of the input to the Chat completions endpoint?

A User's IP address

B Model name

C List of messages

D Temperature setting

User's IP address is not required input for generating chat completions.

What does the 'temperature' parameter control in the Chat completions endpoint?

A The speed of response

B The randomness of the output

C The length of the response

D The language of the response

Temperature controls how random or creative the AI's responses are.

Which message role can be used to guide the AI's behavior in the conversation?

A assistant

B user

C system

D observer

The 'system' role is used to set instructions or context for the AI.

What is the typical format of the response from the Chat completions endpoint?

A A JSON object with choices containing messages

B A single string of text

C An image file

D A CSV file

The response is a JSON object with a 'choices' array, each containing a message with role and content.

Explain how the Chat completions endpoint processes input messages and generates a response.

Think about how a conversation flows between user and AI.

Describe the role of the 'system' message in the Chat completions endpoint.

It’s like giving the AI a role or rules before chatting.

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