Struct RerankResponse 

pub struct RerankResponse {
    pub results: Vec<RerankResult>,
    pub model: Option<String>,
    pub usage: Usage,
    pub provider: String,
    pub response_id: Option<String>,
    pub provider_request_id: Option<String>,
    pub raw: Value,
}

Ranked documents and normalized provider metadata. Provider-specific response data is available through Self::raw.

Fields

results: Vec<RerankResult>

Reranked results sorted by relevance (highest first).

model: Option<String>

Provider-reported model identifier, or None when omitted.

usage: Usage

Token usage for this rerank request; every counter is None when the provider reported none (see Usage).

provider: String

Stable descriptor name of the provider that produced this response, for example "voyageai". Always populated.

response_id: Option<String>

Provider-assigned response-scoped identifier, when reported.

provider_request_id: Option<String>

Transport request ID from HTTP headers, or None when unreported.

raw: Value

Provider response document. Defaults to null until populated.

Implementations

impl RerankResponse

pub fn new(results: Vec<RerankResult>) -> Self

A response carrying results. The driver writes the provider, the transport request id and the reply document; decoders set what the provider reported.

Trait Implementations

impl Clone for RerankResponse

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RerankResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RerankResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RerankResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.