Struct FileSearchRankingOptions 

#[non_exhaustive]
pub struct FileSearchRankingOptions {
    pub ranker: Option<String>,
    pub score_threshold: Option<f64>,
}

Represents ranking options for file search results.

Used By

• FileSearchTool
• AssistantFileSearchSettings (within assistants_shared.rs)
• RunStepDetailsToolCallsFileSearchRankingOptionsObject (within assistants_shared.rs)

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.

ranker: Option<String>

The ranker to use for the file search (auto or default_2024_08_21). Defaults to auto.

score_threshold: Option<f64>

The score threshold for the file search (0 to 1). Defaults to 0.

Implementations

impl FileSearchRankingOptions

pub fn former() -> FileSearchRankingOptionsFormer<FileSearchRankingOptionsFormerDefinition<(), FileSearchRankingOptions, ReturnPreformed>>

Provides a mechanism to initiate the formation process with a default completion behavior.

Trait Implementations

impl Clone for FileSearchRankingOptions

fn clone(&self) -> FileSearchRankingOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileSearchRankingOptions

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

Formats the value using the given formatter.

impl Default for FileSearchRankingOptions

fn default() -> FileSearchRankingOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileSearchRankingOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<__Context, __Formed, __End> EntityToDefinition<__Context, __Formed, __End> for FileSearchRankingOptions

where __End: FormingEnd<FileSearchRankingOptionsFormerDefinitionTypes<__Context, __Formed>>,

type Definition = FileSearchRankingOptionsFormerDefinition<__Context, __Formed, __End>

The specific FormerDefinition associated with this entity.

type Types = FileSearchRankingOptionsFormerDefinitionTypes<__Context, __Formed>

The specific FormerDefinitionTypes associated with this entity.

impl<__Context, __Formed> EntityToDefinitionTypes<__Context, __Formed> for FileSearchRankingOptions

type Types = FileSearchRankingOptionsFormerDefinitionTypes<__Context, __Formed>

Specifies the FormerDefinitionTypes that define the storage, formed entity, and context types used during formation.

impl<Definition> EntityToFormer<Definition> for FileSearchRankingOptions

where Definition: FormerDefinition<Storage = FileSearchRankingOptionsFormerStorage>,

type Former = FileSearchRankingOptionsFormer<Definition>

The type of the former (builder) used for constructing the entity.

fn __f(_: &Definition)

A placeholder function to reference the definition without operational logic.

impl EntityToStorage for FileSearchRankingOptions

type Storage = FileSearchRankingOptionsFormerStorage

The storage type used for forming the entity.

impl PartialEq for FileSearchRankingOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FileSearchRankingOptions

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 FileSearchRankingOptions