Struct Rerank 

pub struct Rerank<D> { /* private fields */ }

Builder returned by rerank; .await runs the call.

Implementations

impl<D> Rerank<D>

pub fn top_n(self, top_n: usize) -> Self

Returns only the top_n most relevant documents.

impl<D> Rerank<D>

pub fn headers(self, headers: Headers) -> Self

Adds request headers.

pub fn header(self, name: &str, value: &str) -> Self

Adds one request header; invalid names or values are ignored.

pub fn provider_options(self, options: ProviderOptions) -> Self

Sets the provider-specific options.

pub fn provider_option( self, provider: impl Into<String>, options: JsonObject, ) -> Self

Sets the options of one provider.

pub fn cancellation(self, token: CancellationToken) -> Self

Sets the cancellation token.

pub fn timeout(self, timeout: Duration) -> Self

Sets the total timeout of the call.

pub fn telemetry(self, options: TelemetryOptions) -> Self

Sets the telemetry options.

impl<D> Rerank<D>

pub fn retry(self, policy: RetryPolicy) -> Self

Sets the retry policy (default: two retries).

pub fn max_retries(self, max_retries: u32) -> Self

Sets the number of retries of the default policy.

impl<D> Rerank<D>

pub fn runtime_context(self, context: JsonValue) -> Self

Sets the application context passed to operation callbacks.

pub fn on_start(self, hook: impl HookFn<RerankCallStartEvent>) -> Self

Adds an awaited callback before the first provider attempt.

pub fn on_end(self, hook: impl HookFn<RerankCallEndEvent>) -> Self

Adds an awaited callback after the entire operation succeeds.

Trait Implementations

impl<D: Debug> Debug for Rerank<D>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<D> IntoFuture for Rerank<D>

where D: Into<RerankDocument> + Clone + Send + 'static,

type Output = Result<RerankResult<D>, Error>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <Rerank<D> as IntoFuture>::Output> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.