Struct RerankRequest 

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

Fields

model: String

query: String

documents: Vec<String>

wire accepts a plain string or a structured object per element

top_n: Option<u32>

Documents are usually plain strings. The wire also accepts structured multimodal document objects ({text?, image?}); that is a JSON-only extension not represented in these generated types (the same way EmbeddingRequest.input stays a repeated string for a JSON-flexible field). Transports may still send plain strings; structured documents ride outside the generated shape.

return_documents: Option<bool>

Implementations

impl RerankRequest

pub fn top_n(&self) -> u32

Returns the value of top_n, or the default value if top_n is unset.

pub fn return_documents(&self) -> bool

Returns the value of return_documents, or the default value if return_documents is unset.

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

fn default() -> Self

Returns the “default value” for a type.

impl Message for RerankRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for RerankRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RerankRequest