-
Notifications
You must be signed in to change notification settings - Fork 112
feat(cli): submit keyless job feedback #221
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
base: main
Are you sure you want to change the base?
Changes from all commits
cf5a9ac
521389c
cf929f4
02baf67
2f3855c
aec2df9
80a8808
fc5f679
b9a61bb
49c4737
328a8b8
7a0847d
dd0af47
5062793
89e878d
9ea44ef
8f6ce95
b0d54d5
4cb90b3
66a980f
ba84855
15c817d
713628d
739a19f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -115,11 +115,17 @@ Single format outputs raw content. Multiple formats (e.g., `--format markdown,li | |||||
|
|
||||||
| ## Feedback | ||||||
|
|
||||||
| After using search results, send `firecrawl search-feedback` (the first feedback per search refunds 1 credit). The full pattern, guard, and rules live in [firecrawl-search](../firecrawl-search/SKILL.md). | ||||||
| **Authenticated:** After using search results, send `firecrawl search-feedback` (the first feedback per search refunds 1 credit). The full pattern, guard, and rules live in [firecrawl-search](../firecrawl-search/SKILL.md). | ||||||
|
|
||||||
| **Keyless:** Submit concise feedback on observed result quality or missing coverage when a keyless Search, Scrape, or Parse result includes a feedback invitation and the host permits it, especially if the result is wrong, incomplete, blocked, or an error. Submit it with `firecrawl feedback <endpoint> <jobId>` with `--rating`, `--task`, `--assessment`, and `--observations-file`, using the job reference and invitation returned in metadata or stderr. Feedback does not determine whether the task is complete. If it is unavailable, declined, or rejected, continue without retries. Run `firecrawl feedback --help` for category-specific observations. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. P2: The keyless requirement list omits Prompt for AI agents |
||||||
|
|
||||||
| For Alexandria feedback about a provider result or coverage gap, see [firecrawl-alexandria](../firecrawl-alexandria/SKILL.md). | ||||||
|
|
||||||
| For non-search endpoint jobs, use `firecrawl feedback <endpoint> <jobId>` to send concise job-level feedback through `/v2/feedback`. Supported endpoints are `search`, `scrape`, `parse`, and `map`. | ||||||
| Use only evidence already available, without interviewing the user or doing extra investigation, and omit sensitive information. Each keyless job accepts one submission. Submit from the same caller IP before the invitation's `expiresAt` deadline, which provides a 24-hour feedback window for the job. Feedback does not consume or restore operation allowance. Do not send legacy issue/note fields as a substitute for keyless observations. | ||||||
|
|
||||||
| The two authentication modes use different request contracts; do not add credentials to submit feedback for a keyless job. | ||||||
|
|
||||||
| For non-search endpoint jobs, use `firecrawl feedback <endpoint> <jobId>` to send concise job-level feedback through `/v2/feedback`. Supported endpoints are `search`, `scrape`, `parse`, and `map`. The following example is for authenticated feedback: | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. P3: This sentence is self-contradictory: it says "For non-search endpoint jobs" but then lists Prompt for AI agents
Suggested change
|
||||||
|
|
||||||
| ```bash | ||||||
| firecrawl feedback scrape "$SCRAPE_ID" \ | ||||||
|
|
@@ -134,7 +140,9 @@ firecrawl feedback scrape "$SCRAPE_ID" \ | |||||
|
|
||||||
| Keep generic feedback small: issue codes, tags, short notes, URLs, page numbers, and small metadata objects — never raw scrape/parse outputs or full page contents. | ||||||
|
|
||||||
| **Opt out:** `export FIRECRAWL_NO_ENDPOINT_FEEDBACK=1` makes the CLI skip every endpoint feedback call silently. Respect that flag — do not try to work around it. | ||||||
| Keyless feedback is available for successful and failed jobs when the response includes a job reference. For an explicitly failed job, use observation `kind: "failure"` and `reason: "timeout"`, `"transport_error"`, `"proxy_error"`, or `"other"`; report only the error already returned. Keep the submission under 8 KiB including server defaults. Run `firecrawl feedback --help` for reason definitions and the complete contract. | ||||||
|
|
||||||
| **Authenticated feedback preference:** `FIRECRAWL_NO_ENDPOINT_FEEDBACK=1` or `FIRECRAWL_DISABLE_ENDPOINT_FEEDBACK=1` skips authenticated endpoint feedback calls. Respect these flags for authenticated jobs. Keyless jobs retain server-issued invitations and optional submissions regardless of these flags. | ||||||
|
|
||||||
| ## Parallelization | ||||||
|
|
||||||
|
|
||||||
Uh oh!
There was an error while loading. Please reload this page.