Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update prompting-guide.mdx #747

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Conversation

kati3-design
Copy link
Contributor

@kati3-design kati3-design commented Aug 28, 2024

🚀 This description was created by Ellipsis for commit 245d44c

Summary:

Replaces image with a comprehensive task prompting guide in docs/getting-started/prompting-guide.mdx, detailing effective use of Skyvern for task automation.

Key points:

  • Replaces image with detailed task prompting guide in docs/getting-started/prompting-guide.mdx.
  • Adds sections on using keywords "complete" and "terminate" for task completion.
  • Provides guidelines for setting clear, single-goal tasks with guardrails.
  • Includes examples of good and poor navigation goals for Skyvern.
  • Details input types like URL, Navigation Goal, Data Extraction Goal, etc.

Generated with ❤️ by ellipsis.dev

@suchintan suchintan merged commit 2786e2e into Skyvern-AI:main Aug 28, 2024
2 checks passed
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❌ Changes requested. Reviewed everything up to 245d44c in 15 seconds

More details
  • Looked at 96 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_xwAiK7i99Yrcw7yz


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Have a very clear idea of the problem you’re trying to have Skyvern solve. Ask yourself:

What is the my goal? Can I describe it very clearly so Skyvern knows I've accomplished my goal?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
What is the my goal? Can I describe it very clearly so Skyvern knows I've accomplished my goal?
What is my goal? Can I describe it very clearly so Skyvern knows I've accomplished my goal?

- For instance, “generate an insurance quote” will be more successful than a sequence like “generate multiple insurance quotes and compare them to find the best option”
- Add guardrails like “close cookie dialogs” to instruct Skyvern when it encounters unexpected obstacles
- Some foreseeable obstacles include pop-ups, confirmations, cookie popups, ad-banners, and more
- Give Skyvern concrete examples of what to do and not to do to. For example, asking it to navigate to the home page if it can't find it's looking for can be a good idea.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Give Skyvern concrete examples of what to do and not to do to. For example, asking it to navigate to the home page if it can't find it's looking for can be a good idea.
- Give Skyvern concrete examples of what to do and not to do to. For example, asking it to navigate to the home page if it can't find its looking for can be a good idea.


1. *(required) URL:* Skyvern's starting point
2. *(often required) Navigation Goal:* details where Skyvern is going and what Skyvern is doing. Clear Navigation Goals will be a single goal, broken down into steps. You need to specify when the goal is complete, using “COMPLETE”, or when to abandon that goal, using “TERMINATE”
1. the navigation goal is not used to load the URL or any
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. the navigation goal is not used to load the URL or any
1. The navigation goal is not used to load the URL or any other resources.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants