Struct RerankRequest 

pub struct RerankRequest {
    pub model: String,
    pub query: String,
    pub documents: Vec<RerankDocument>,
    pub top_n: Option<u32>,
    pub return_documents: Option<bool>,
}

POST /v1/rerank request body.

Fields

model: String

query: String

documents: Vec<RerankDocument>

top_n: Option<u32>

return_documents: Option<bool>

Implementations

impl RerankRequest

pub fn new( model: impl Into<String>, query: impl Into<String>, documents: impl IntoIterator<Item = impl Into<RerankDocument>>, ) -> Self

Start a rerank request. documents accepts plain strings (vec!["a", "b"]) or structured multimodal objects (via serde_json::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 PartialEq for RerankRequest

fn eq(&self, other: &RerankRequest) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

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 StructuralPartialEq for RerankRequest