Struct RerankRequest 

#[non_exhaustive]
pub struct RerankRequest {
    pub model: OpenAiModelId,
    pub query: String,
    pub documents: Vec<RerankDocument>,
    pub top_n: Option<u32>,
    pub instruct: Option<String>,
    pub return_documents: Option<bool>,
    pub extra: Extra,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

model: OpenAiModelId

query: String

documents: Vec<RerankDocument>

top_n: Option<u32>

instruct: Option<String>

return_documents: Option<bool>

extra: Extra

Implementations

impl RerankRequest

pub fn builder() -> WireRerankRequestBuilder

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