Feedback de busca

Enviar feedback para um job de busca

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>",
  "valuableResults": [
    {
      "position": 50,
      "reason": "<string>"
    }
  ],
  "valuableSources": [
    {
      "url": "<string>",
      "reason": "<string>"
    }
  ]
}
'

import requests

url = "https://api.firecrawl.dev/v2/search/{jobId}/feedback"

payload = {
    "integration": "<string>",
    "missingContent": [
        {
            "topic": "<string>",
            "description": "<string>"
        }
    ],
    "origin": "api",
    "querySuggestions": "<string>",
    "valuableResults": [
        {
            "position": 50,
            "reason": "<string>"
        }
    ],
    "valuableSources": [
        {
            "url": "<string>",
            "reason": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration: '<string>',
    missingContent: [{topic: '<string>', description: '<string>'}],
    origin: 'api',
    querySuggestions: '<string>',
    valuableResults: [{position: 50, reason: '<string>'}],
    valuableSources: [{url: '<string>', reason: '<string>'}]
  })
};

fetch('https://api.firecrawl.dev/v2/search/{jobId}/feedback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firecrawl.dev/v2/search/{jobId}/feedback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'integration' => '<string>',
    'missingContent' => [
        [
                'topic' => '<string>',
                'description' => '<string>'
        ]
    ],
    'origin' => 'api',
    'querySuggestions' => '<string>',
    'valuableResults' => [
        [
                'position' => 50,
                'reason' => '<string>'
        ]
    ],
    'valuableSources' => [
        [
                'url' => '<string>',
                'reason' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firecrawl.dev/v2/search/{jobId}/feedback"

	payload := strings.NewReader("{\n  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v2/search/{jobId}/feedback")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/search/{jobId}/feedback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "creditsRefunded": 123,
  "feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success": true,
  "alreadySubmitted": true,
  "creditsRefundedToday": 123,
  "dailyCapReached": true,
  "dailyRefundCap": 123,
  "warning": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

POST

{jobId}

feedback

Enviar feedback para um job de busca

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>",
  "valuableResults": [
    {
      "position": 50,
      "reason": "<string>"
    }
  ],
  "valuableSources": [
    {
      "url": "<string>",
      "reason": "<string>"
    }
  ]
}
'

import requests

url = "https://api.firecrawl.dev/v2/search/{jobId}/feedback"

payload = {
    "integration": "<string>",
    "missingContent": [
        {
            "topic": "<string>",
            "description": "<string>"
        }
    ],
    "origin": "api",
    "querySuggestions": "<string>",
    "valuableResults": [
        {
            "position": 50,
            "reason": "<string>"
        }
    ],
    "valuableSources": [
        {
            "url": "<string>",
            "reason": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    integration: '<string>',
    missingContent: [{topic: '<string>', description: '<string>'}],
    origin: 'api',
    querySuggestions: '<string>',
    valuableResults: [{position: 50, reason: '<string>'}],
    valuableSources: [{url: '<string>', reason: '<string>'}]
  })
};

fetch('https://api.firecrawl.dev/v2/search/{jobId}/feedback', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firecrawl.dev/v2/search/{jobId}/feedback",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'integration' => '<string>',
    'missingContent' => [
        [
                'topic' => '<string>',
                'description' => '<string>'
        ]
    ],
    'origin' => 'api',
    'querySuggestions' => '<string>',
    'valuableResults' => [
        [
                'position' => 50,
                'reason' => '<string>'
        ]
    ],
    'valuableSources' => [
        [
                'url' => '<string>',
                'reason' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firecrawl.dev/v2/search/{jobId}/feedback"

	payload := strings.NewReader("{\n  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v2/search/{jobId}/feedback")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/search/{jobId}/feedback")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "creditsRefunded": 123,
  "feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success": true,
  "alreadySubmitted": true,
  "creditsRefundedToday": 123,
  "dailyCapReached": true,
  "dailyRefundCap": 123,
  "warning": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

Use o feedback de busca depois de usar um resultado de search ou quando ele não ajudar. O feedback melhora a qualidade dos resultados e pode reembolsar 1 crédito no primeiro envio de feedback para um job de busca, sujeito aos limites da equipe. Use valuableResults para marcar os resultados úteis de acordo com a posição em que apareceram na resposta. Cada entrada indica o grupo de source (web, images ou news) e a position do resultado dentro desse grupo, contada a partir de 1, já que cada grupo tem numeração própria começando em 1. Liste todos os resultados úteis: resultados não listados são considerados não úteis, e posições que excedem a quantidade de resultados retornados por um grupo são ignoradas. Isso também funciona para resultados de notícias e imagens que não têm url. Use valuableSources para indicar URLs úteis, inclusive as que não estavam entre os resultados retornados.

Exemplo de requisição

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."
      }
    ],
    "valuableResults": [
      {
        "source": "web",
        "position": 1,
        "reason": "Answered the question directly."
      },
      {
        "source": "news",
        "position": 2
      }
    ],
    "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"
  }'

Autorizações

Authorization

string

header

obrigatório

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

Parâmetros de caminho

jobId

string<uuid>

obrigatório

ID do job de busca retornado por /search.

Corpo

application/json

Para 'good', inclua valuableSources ou valuableResults. Para 'partial', inclua valuableSources, valuableResults ou missingContent. Para 'bad', inclua missingContent ou querySuggestions.

rating

enum<string>

obrigatório

Opções disponíveis:

good,

partial,

bad

integration

string | null

missingContent

object[]

Maximum array length: 20

Show child attributes

origin

string

padrão:api

querySuggestions

string

Maximum string length: 2000

valuableResults

object[]

Resultados úteis, cada um identificado pelo grupo data em que aparece e por sua posição nesse grupo, contada a partir de 1. Os resultados são retornados em grupos (data.web, data.images, data.news), cada um com numeração independente a partir de 1, portanto source é obrigatório. Liste todos os resultados úteis; os resultados não listados são considerados não úteis. Posições que excedam o número de resultados efetivamente retornados pelo grupo são ignoradas.

Maximum array length: 50

Show child attributes

valuableSources

object[]

Maximum array length: 50

Show child attributes

Resposta

Feedback registrado

creditsRefunded

number

obrigatório

feedbackId

string<uuid>

obrigatório

success

boolean

obrigatório

Exemplo:

true

alreadySubmitted

boolean

creditsRefundedToday

number

dailyCapReached

boolean

dailyRefundCap

number

warning

string

Usando a API

Endpoints de busca

Endpoints /scrape

Endpoints para interagir / Browser Sandbox

Endpoints do Research Index

Endpoints do índice para desenvolvedores

Endpoints do índice governamental

Endpoints de mapeamento

Endpoints de Parse

Endpoints de rastreamento

Endpoints de monitoramento

Endpoints de agente

Endpoints de feedback

Endpoints de depuração agêntica

Endpoints da conta

Payloads de webhook

Firecrawl for Platforms

Exemplo de requisição

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Exemplo de requisição

Autorizações

Parâmetros de caminho

Corpo

Resposta

Exemplo de requisição