Skip to content

README feedback examples are silent no-ops — feedbackId is undocumented #21

Open

Description

@thesoulpole

Follow-up to #15 (thx for that fix — the loop does work now when driven via SearchOptions.feedbackId).

Problem: the README still teaches the old, broken pattern in all examples:

  • L45: backend.recordFeedback(results[0].id, 0.9);
  • L76: db.recordFeedback(hits[0].id, 1.0);

recordFeedback() looks up the trajectory by the feedbackId passed to searchAsync(q, k, { feedbackId }). A document id never matches, and the miss returns silently — so anyone coding from the README gets a no-op learning loop with no error. feedbackId currently appears nowhere in README or docs/ (grep on alpha.20).

Suggested:

  1. Update the README examples to the feedbackId flow.
  2. Document that recordFeedback() with an unknown id is ignored — or better, make that case throw/warn. A silent no-op on the headline feature is rough.

Also: #13 / #14 are fixed by #15 but still sitting open — they can be closed.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions