Tavily

Submit feedback

Score the quality of a prior call to help improve future results.

POST /tavily/feedback● Supported

Official Tavily docs ↗

Request body

  • request_idstring可选

    The search request to give feedback on, as returned in the `request_id` field of the search response. When provided, the feedback applies to this request.

  • session_idstring可选

    The session to give feedback on — the value you sent in the `X-Session-Id` header. When `request_id` is omitted, the feedback applies to the whole session. Optional if `request_id` is provided.

  • agent_scorenumber | string可选

    Overall score for how relevant and useful the results were for your task.

  • human_scorenumber | string可选

    Feedback from your end user, if you collect it.

  • extra_scoresarray可选

    Additional labeled scores for the dimensions you care about.

    ▸ 展开子字段(2)
    • labelstring必填

      Name of the dimension being scored.

    • valuenumber | string必填

      A numeric score, or a short string label (max 64 characters).

  • commentstring可选

    Free-text explanation of the feedback.

  • response_deliveredstring可选

    The final answer you produced using the results.

  • used_idsarray可选

    IDs of the results you actually used in your answer. Alternative to `used_urls`.

  • used_urlsarray可选

    URLs of the results you actually used in your answer. Alternative to `used_ids`.

  • used_citationsarray可选

    The specific content snippets you quoted from the results.

  • ▸ 更多参数(1)
    • urls_scoresarray可选

      Per-result feedback. Identify each result by `id` or `url`.

      ▸ 展开子字段(5)
      • idstring可选

        The `id` of the result, as returned in the search response.

      • urlstring可选

        The URL of the result. Use instead of `id` when you don't have the result ID.

      • agent_scorenumber | string可选

        Score for this specific result.

      • scoresarray可选

        Additional labeled scores for this result.

      • commentstring可选

        Free-text explanation of the feedback on this result.

Returns

200

Forwarded to Tavily as is and not billed (Tavily's own pricing does not charge for feedback).

Errors follow the Tavily format — see error codes

Response

HTTP 200

Feedback accepted

application/json

NameTypeDescription
successbooleanWhether the feedback was accepted.
feedback_idstringUnique identifier of this feedback submission.
response_timenumberResponse time of this feedback request in seconds.