Skip to content

Commit 8a293f4

Browse files
committed
docs: note the Cohere/Voyage model check needs non-empty docs
1 parent e01fbd3 commit 8a293f4

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Providers reply with positions into the request array, so each score maps back t
6767

6868
## Errors
6969

70-
Failures throw `RerankRequestError` (`extends Error`), carrying the classified `InferenceError` from `@intx/inference` as `reason` and the request `url`. That covers transport failures, HTTP errors, and replies in the wrong shape; retryable errors are retried first under the `retryPolicy` option, which defaults to `createDefaultRetryPolicy()`. An invalid config, including a missing `model` for Cohere or Voyage, throws arktype's `TraversalError` before any request is sent; an `apiStyle` the registry does not know throws a plain `Error` naming it.
70+
Failures throw `RerankRequestError` (`extends Error`), carrying the classified `InferenceError` from `@intx/inference` as `reason` and the request `url`. That covers transport failures, HTTP errors, and replies in the wrong shape; retryable errors are retried first under the `retryPolicy` option, which defaults to `createDefaultRetryPolicy()`. An invalid config throws arktype's `TraversalError` before any request is sent, as does a missing `model` for Cohere or Voyage once `docs` is non-empty (an empty `docs` returns `[]` without building a request); an `apiStyle` the registry does not know throws a plain `Error` naming it.
7171

7272
Fallback is left to the caller: catch the error and keep your own ordering if a reranker outage should not fail search.
7373

0 commit comments

Comments
 (0)