Circle V2 API Docs
    Preparing search index...

    Function documentRelevanceEvaluator

    • Reference-based recall/precision for find_documents, scored by document id against the labeled gold outputs.documents. Empty gold is the abstention case (should pick nothing) → an abstention metric; unlabeled examples (no gold documents) are skipped. Comments name the missed/extra ids.

      Parameters

      • __namedParameters: { example: Example; run: Run }

      Returns
          | {
              comment: string;
              key: string;
              results?: undefined;
              score?: undefined;
          }
          | { comment: string; key: string; results?: undefined; score: number }
          | {
              comment?: undefined;
              key?: undefined;
              results: { comment: string; key: string; score?: number }[];
              score?: undefined;
          }