Struct OpenAIFileSearchTool 

pub struct OpenAIFileSearchTool {
    pub vector_store_ids: Vec<String>,
    pub max_num_results: Option<u32>,
    pub include_results: bool,
    pub filters: Option<Value>,
}

OpenAI hosted file search configuration.

Fields

vector_store_ids: Vec<String>

Vector stores to search.

max_num_results: Option<u32>

Maximum number of search results.

include_results: bool

Whether to request file_search_call.results in the response include list.

filters: Option<Value>

Official filter object.

Implementations

impl OpenAIFileSearchTool

pub fn new(vector_store_ids: impl Into<Vec<String>>) -> Self

Creates file search over the provided vector stores.

pub const fn max_num_results(self, value: u32) -> Self

Sets maximum result count.

pub const fn include_results(self, include: bool) -> Self

Requests file search result inclusion.

pub fn filters(self, filters: Value) -> Self

Sets the official filter object.

Trait Implementations

impl Clone for OpenAIFileSearchTool

fn clone(&self) -> OpenAIFileSearchTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAIFileSearchTool

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenAIFileSearchTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OpenAIFileSearchTool

impl PartialEq for OpenAIFileSearchTool

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OpenAIFileSearchTool

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 OpenAIFileSearchTool