Introduction to the 'Emerald' Project

Welcome to the project! In this module we will provide you with full instructions to ensure you
produce valid contributions to this project where you will be creating user prompts and
annotating them.

Emerald is the code name for this particular project.

If you have questions for your project manager etc please ensure you refer to these code names.
If you think you know who the client is etc, shhh 🤫 Remember, client and project details are
confidential and these must not be breached!

Terminology and definitions

Before you start reading the module, please get familiar with the following terms and
definitions:

 Function:an action that will be performed within a specific website or tool.

o Example: Translate in Google Translate, Image search in Bing Image Search, etc.
 Prompt: a question/command similar to what you would input to perform a Google
search.
o Example: Show five images of traditional Vietnamese dishes; Weather in
Barcelona today; etc.
 Parameter: a piece of information associated to a prompt
 Multi tool: a prompt that requires actions from multiple different tools in a sequence OR
two separate actions from the same tool, to finish the task.

Project Aim

In this task, you will create user prompts for multiple functions and annotate them. This means
that you have to create prompts where the actions can be completed by using at least 2 different
functions in a sequence. Example: “Find the lyrics of Queen’s song “Bohemian rhapsody” and
translate them into German”. To accomplish this action, we need:

- A first function to find the song lyrics

- A second function to translate the text

In this document we’re giving you the step-by-step instructions for creating and annotating
prompts for multi-tool.

IMPORTANT: It is strictly forbidden to use any kind of AI GPT tools. All prompts should
be authored by you. If we detect that AI GPT tools have been used to provide entire or
partial prompts, you will be removed from the project without pay
Emerald Step-by-Step Instructions
1
Selecting the functions with the associated parameters

For each hit you will have a vast selection of functions in the upper part of the screen.You can
search for functions by entering keywords (eg. search, news, translate, hotels, scores, etc.)

When you choose the functions, please make sure:

 You do not always use the same combination of functions. Customer wants variety.
 You select 2 functions that make sense between each other. Examples:
o Bad prompt: “Tell me the earthquakes in 2023 and find me a job as Cloud
Engineer” -- > this prompt implies 2 functions (looking for earthquake info +
looking for Cloud engineer job) that are completely irrelevant to each other and
make the whole query look unrealistic (no one would actually perform this kind
of search in a browser as it makes no sense)
o Good prompt: “Find me the location of the last earthquake in the US, and then
find a job next to that location as a Geologist” --> this prompt implies 2 functions
(looking for earthquake info + looking for a Geologist job) that are relevant and
make sense together. The query is realistic and valid for the purpose of the task.

Reminder about the function table:

  Name: the name of the function
 Description: a description of what the function does/is about (hover over it in case it is
truncated)
 Documentation: a link where you can see more details about the API, the function(s)
and parameters used. This will open a technical page within Rapid API that you should
use/consult before creating your prompt and filling out the parameters. Please also watch
the additional demo (single&multi tool) on Teams to understand why and how this is
helpful.

Click on the highlighted icon to expand the view and get more insight into the
various functions this API offers, the brief description for each, and the parameter
values and how they should be filled.
  Required parameters: a list of mandatory information that the prompt has to contain
(hover them to see a description)

 Optional parameters: a list of optional information that the prompt may contain (hover
them to see a description)

2
Make sure the functions are sorted correctly

The functions will be automatically listed in order of selection. You have to check and make sure
they are sorted in sequence, following the order of the actions that have to take place in order to
accomplish the prompt. You can sort them by pressing the arrow icons. Do this before you start
annotating the parameter values.
For example, for the functions in the left screenshot, we are working on a prompt to:

 get the video description from a Youtube video using the video ID
 detect the language of the Youtube video description with a Google Translate – Detect
query

Hence the Youtube search goes first, followed by the detection of the language.

3
Write a prompt for the given functions

Write your own prompt for the selected functions. In order to be valid, the prompt you create
should:

 Be related to the given functions

 Contain context so that the query can be understood even without knowing the functions
 Include information for all the required parameters
 Be well written, flow naturally and have correct punctuation/grammar
 May include information for the optional parameters (this is not mandatory)
Example:

In this case, we had to create a prompt for the functions “Youtube V2”, with the required
parameter being a valid video ID, and “Google Translate - Detect”, with the required parameter
being a “language query”. Hence the request to get the description of the video ID , and do a
Google Translate detection of the language used.

Example of another prompt:

Functions Descriptio Required Optional

n parameters parameters
1. YouTube 1. Fetch the 1. Query
Search Results YouTube
Search Results
and the
information for
each item for a
specific search
term, without
any limits!
2. Youtube 2. Download 2. ID
Video YouTube
Download Info; Videos/MP4.
Forever Free
Version;

For these functions, we have to create a prompt that includes a query about finding a video on
Youtube and then downloading it for the user. Each function has its required parameters, with
the first one being the query for the Youtube search. The second being the ID of the video URL
that will be used for the download. An example of good prompt for this would be: “I’d like to
look for the music video “Flowers” from Miley Cyrus and download it”.
3.1 Select your confidence level

Please, select a value for how confident you feel about the functions and the prompt. As you
think about your confidence level, ask yourself:

 Do I understand what the functions can do for me? What are some scenarios and
situations that I can use these functions for?

Note: you should only mark Low after you have conducted
research to better understand the functions. If after research
you still do not feel confident to generate a good user
prompt, then mark Low.

3.2 Answer an additional question through a radio button

For this task, the answer to this question will be Yes most of the time.
4
Annotating the parameters

This step consists of three parts. For each function you have to first annotate the parameters, then
explain why the step was need, followed by validating the response. These steps should be
completed for each function separately.

4.1 Annotate the parameters and add comments

To do this you will find a table with:

 Key: The list of all the parameters associated to that function (both the mandatory and
the optional ones)
 Description: The description of the parameters which sometimes includes info about the
annotation format.
 Required: This field explains if the parameter is mandatory (true) or optional (false)
 Type: the value type
 Value: the box where you have to insert your annotation

To do the annotation you have to fill the “Value” field with the corresponding parameter from
the prompt you created. Make sure you know the format of the value that should be inserted.
Sometimes it’s provided in the description, other times you have to check the documentation for
the examples given.
4.2 Provide the comment

After completing the annotation, you have to explain why this step is necessary to accomplish
the prompt. In the above example, we provided the Youtube video ID, as the required field, and
explained that in order to execute the prompt we first need to get the video description.

Make sure comments are:

 Clearly written, in English (no grammatical or spelling errors, correct punctuation, etc.)
 Informative: they should clearly explain why the step is necessary to accomplish the
prompt. Do not provide vague responses.
 Specific: they should relate to the prompt and be specific for each function, as this task
will include 2 or more functions per prompt.

Please, remember:

 All mandatory parameters should be present in the prompt and should be annotated;
 Optional parameters should be annotated only when they are present in the prompt;
 When annotating search or translation queries, please ignore the quotation marks (“ ”)
or the ending punctuation (examples 1 and 2) unless it is relevant for the search (example
3).

Function Prompt Parameter value for

"query"?
Google Search Who was elected as Who was elected as
President in Canada this President in Canada this
year? year
Google Translate - Detect “Burrito”, in what Burrito
language is this word?
Google Translate - Please translate “Hola, Hola, cómo estás?
Translate cómo estás?” into
Swedish.
4.3 Data validation

Here, the tool will generate a response based on the function used and the values inserted. To do
this, click the “Get response & validate” button. You cannot click this button unless all of the
previous steps have been completed.

You will get a response from the function. Look for the data you are validating in the table (in
this example, it is the Youtube video description). If you do not get any error message, it means
the function is valid and you can select “Response is valid” as a confirmation button. If you get
an error message, it could mean your parameter values might be incorrect/invalid and the prompt
might have to be changed. This should be checked individually each time depending on the
specific error.

If everything looks good, you can move on to the next function. You should click on the
necessary field from the previous validation table (as shown above, we are looking for the video
description). A green checkmark will appear next to it and the text is automatically copied.

At this point, a Paste icon will appear next to the Value box of the second function:
You can click this icon to have the parameter automatically pasted there. Avoid manually copy-
pasting the information, if you need the entire value from the response.

In our example, we have copied the description text from the first response into the “Value” field
of the second function parameter. Provide the comment why this step is necessary and click on
“Get response & validate”. Select the response and validate it, as shown below.

Once all of the above steps are done, quickly review your prompt and annotations
to make sure there are no mistakes, then click Submit.