Struct FileSearchTool

pub struct FileSearchTool {
    pub vector_store_ids: Vec<String>,
    pub max_num_results: Option<u64>,
    pub ranking_options: Option<RankingOptions>,
    pub filters: Option<Filters>,
}

A tool that searches for relevant content from uploaded files. Learn more about the file search tool.

Fields

vector_store_ids: Vec<String>

The IDs of the vector stores to search.

max_num_results: Option<u64>

The maximum number of results to return. This number should be between 1 and 50 inclusive.

ranking_options: Option<RankingOptions>

Ranking options for search.

filters: Option<Filters>

A filter to apply.

Implementations

impl FileSearchTool

pub fn builder() -> FileSearchToolBuilder<((), (), (), ())>

Create a builder for building FileSearchTool. On the builder, call .vector_store_ids(...), .max_num_results(...)(optional), .ranking_options(...)(optional), .filters(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of FileSearchTool.

Trait Implementations

impl Clone for FileSearchTool

fn clone(&self) -> FileSearchTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileSearchTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileSearchTool

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FileSearchTool

fn eq(&self, other: &FileSearchTool) -> 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 FileSearchTool

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 FileSearchTool