Passer au contenu principal
POST
/
search
/
{jobId}
/
feedback
Envoyer un retour sur une tâche de recherche
curl --request POST \
  --url https://api.firecrawl.dev/v2/search/{jobId}/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration": "<string>",
  "missingContent": [
    {
      "topic": "<string>",
      "description": "<string>"
    }
  ],
  "origin": "api",
  "querySuggestions": "<string>",
  "valuableSources": [
    {
      "url": "<string>",
      "reason": "<string>"
    }
  ]
}
'
{
  "creditsRefunded": 123,
  "feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success": true,
  "alreadySubmitted": true,
  "creditsRefundedToday": 123,
  "dailyCapReached": true,
  "dailyRefundCap": 123,
  "warning": "<string>"
}
Utilisez le retour sur la recherche après avoir utilisé un résultat search ou lorsqu’il ne s’avère pas utile. Le retour améliore la qualité des résultats et peut donner lieu au remboursement d’1 crédit pour le premier envoi de retour sur une tâche de recherche, sous réserve des limites de l’équipe.

Exemple de requête

curl -X POST "https://api.firecrawl.dev/v2/search/550e8400-e29b-41d4-a716-446655440000/feedback" \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rating": "good",
    "valuableSources": [
      {
        "url": "https://docs.firecrawl.dev/features/search",
        "reason": "Most up-to-date description of /search."
      }
    ],
    "missingContent": [
      {
        "topic": "Pricing for the search endpoint",
        "description": "No pricing tier table for /search specifically."
      }
    ],
    "querySuggestions": "Boost docs.firecrawl.dev for queries that mention Firecrawl"
  }'

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

jobId
string<uuid>
requis

ID de tâche de recherche renvoyé par /search.

Corps

application/json

Pour « good », incluez valuableSources. Pour « partial », incluez valuableSources ou missingContent. Pour « bad », incluez missingContent ou querySuggestions.

rating
enum<string>
requis
Options disponibles:
good,
partial,
bad
integration
string | null
missingContent
object[]
Maximum array length: 20
origin
string
défaut:api
querySuggestions
string
Maximum string length: 2000
valuableSources
object[]
Maximum array length: 50

Réponse

Retour enregistré

creditsRefunded
number
requis
feedbackId
string<uuid>
requis
success
boolean
requis
Exemple:

true

alreadySubmitted
boolean
creditsRefundedToday
number
dailyCapReached
boolean
dailyRefundCap
number
warning
string