@qtsurfer/api-client
    Preparing search index...

    Function cancelSweep

    • Cancel a running parameter sweep Requests cancellation between parameter vectors. Completed rows remain readable.

      Cancelling is a request, not a stop: the sweep reports status: CANCELLED (and state.status: Aborted) as soon as the request is accepted, while runs that were already in flight are still finishing. Until they have, progress.pendingShards is above 0, and progress.done and the leaderboard can still grow after CANCELLED is first seen. A client that needs the final set of rows, to store them or to mark the rest as not run, keeps reading until progress.pendingShards is 0; the wait is bounded by how long one run takes.

      Type Parameters

      • ThrowOnError extends boolean = false

      Parameters

      Returns RequestResult<
          { status: "cancelling"; sweepId: string },
          ResponseError,
          ThrowOnError,
      >