Prompt Writing
Last updated
Last updated
1. What makes a good prompt for a CodeWords function?
A good prompt should describe the expected inputs and outputs. It should detail the processing steps involved.
The more detailed your prompt, the higher chance the function will align with your expectations.
A vague description would leave a lot of decision to the Builder, it will still be able to build something but it might not be what you expect, whereas a detailed one would ensure that it builds what you have in mind.
Pro Tip: get inspiration from the templates
2. How detailed should the steps in a prompt be?
The steps should be specific enough to convey the required actions without ambiguity. Each step should be actionable and independent, referencing the available integrations. See what you can use to build in the Integrations and Packages section. Check out the Example Library for inspiration on how the prompt should look like.
I want an app that takes multiple articles on the same topic and summarise them into one, easy to read article with as minimal bias as possible
I want an app that takes multiple articles on the same topic and summarise them into one, easy to read article with as minimal bias as possible. The input is a list of URLs to the articles. Summarise and extract the name of the publisher of the article. Finally, concatenate all of the summaries together with the publisher's name and merge all the summaries together.
I want an app that takes multiple articles on the same topic and summarises them all into one succinct, easy to read article with as minimal bias as possible. Here are the steps it should follow:
Take a list of URLs to the articles as input.
Use the Web Renderer API to pull content for each of the articles.
Use the GPT-based AI API to summarise and extract the name of the publisher of the article.
Concatenate all of the summaries together with the publisher's name and use the GPT-based AI to merge all the summaries together.
The output should be a text paragraph.
Pro Tip: use the Check & Enhance feature to let our AI rewrite your prompt
3. What are common pitfalls to avoid in problem statements?
Avoid vagueness in describing what the tool should do, omitting the types of inputs or outputs, and assuming the system will manage state or user sessions. Also, avoid overly complex descriptions that go beyond the capabilities of stateless processing or the integrations available.
4. Can you provide an example of how to format inputs and outputs in a problem statement?
Yes, always specify what form the inputs will take (e.g., a URL, a file object like image.png, a JSON object) and describe the expected format of the outputs (e.g., a text file, JSON response). This clarity helps in setting the correct expectations and the technical scope of the function.
5. What should I include if the problem involves external data sources?
If your function needs to interact with external data sources like web pages or databases, specify any necessary authentication details or API keys as inputs.
Or get in touch with us at support@agemo.ai