Struct RerankRequest 

pub struct RerankRequest {
    pub query: String,
    pub documents: Vec<String>,
    pub model: String,
    pub top_k: Option<usize>,
    pub return_documents: bool,
    pub rid: Option<StringOrArray>,
    pub user: Option<String>,
}

Fields

query: String

The query text to rank documents against

documents: Vec<String>

List of documents to be ranked

model: String

Model to use for reranking

top_k: Option<usize>

Maximum number of documents to return (optional)

return_documents: bool

Whether to return documents in addition to scores

rid: Option<StringOrArray>

Request ID for tracking

user: Option<String>

User identifier

Implementations

impl RerankRequest

pub fn effective_top_k(&self) -> usize

Get the effective top_k value

Trait Implementations

impl Clone for RerankRequest

fn clone(&self) -> RerankRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RerankRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RerankRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<V1RerankReqInput> for RerankRequest

Convert V1RerankReqInput to RerankRequest

fn from(v1: V1RerankReqInput) -> Self

Converts to this type from the input type.

impl GenerationRequest for RerankRequest

fn get_model(&self) -> Option<&str>

Get the model name if specified

fn is_stream(&self) -> bool

Check if the request is for streaming

fn extract_text_for_routing(&self) -> String

Extract text content for routing decisions

impl JsonSchema for RerankRequest

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Normalizable for RerankRequest

fn normalize(&mut self)

Normalize the request by applying defaults and transformations

impl Serialize for RerankRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for RerankRequest

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for RerankRequest

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>