Struct CreateSearchRequest

pub struct CreateSearchRequest {
    pub query: String,
    pub documents: Option<Option<Vec<String>>>,
    pub file: Option<Option<String>>,
    pub max_rerank: Option<Option<i32>>,
    pub return_metadata: Option<Option<bool>>,
    pub user: Option<String>,
}

Fields

query: String

Query to search against the documents.

documents: Option<Option<Vec<String>>>

Up to 200 documents to search over, provided as a list of strings. The maximum document length (in tokens) is 2034 minus the number of tokens in the query. You should specify either documents or a file, but not both.

file: Option<Option<String>>

The ID of an uploaded file that contains documents to search over. You should specify either documents or a file, but not both.

max_rerank: Option<Option<i32>>

The maximum number of documents to be re-ranked and returned by search. This flag only takes effect when file is set.

return_metadata: Option<Option<bool>>

A special boolean flag for showing metadata. If set to true, each document entry in the returned JSON will contain a "metadata" field. This flag only takes effect when file is set.

user: Option<String>

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Implementations

impl CreateSearchRequest

pub fn new(query: String) -> CreateSearchRequest

Trait Implementations

impl Clone for CreateSearchRequest

fn clone(&self) -> CreateSearchRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateSearchRequest

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

Formats the value using the given formatter.

impl Default for CreateSearchRequest

fn default() -> CreateSearchRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateSearchRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateSearchRequest

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

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 CreateSearchRequest