Struct VectorStoreFileBatches 

pub struct VectorStoreFileBatches<'c, C: Config> {
    pub vector_store_id: String,
    /* private fields */
}

Available on crate feature vectorstore only.

Vector store file batches represent operations to add multiple files to a vector store.

Related guide: File Search

Fields

vector_store_id: String

Implementations

impl<'c, C: Config> VectorStoreFileBatches<'c, C>

pub fn new(client: &'c Client<C>, vector_store_id: &str) -> Self

pub async fn create( &self, request: CreateVectorStoreFileBatchRequest, ) -> Result<VectorStoreFileBatchObject, OpenAIError>

Create vector store file batch

pub async fn create_byot<T0: Serialize, R: DeserializeOwned>( &self, request: T0, ) -> Result<R, OpenAIError>

Create vector store file batch

pub async fn retrieve( &self, batch_id: &str, ) -> Result<VectorStoreFileBatchObject, OpenAIError>

Retrieves a vector store file batch.

pub async fn retrieve_byot<T0: Display, R: DeserializeOwned>( &self, batch_id: T0, ) -> Result<R, OpenAIError>

Retrieves a vector store file batch.

pub async fn cancel( &self, batch_id: &str, ) -> Result<VectorStoreFileBatchObject, OpenAIError>

Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

pub async fn cancel_byot<T0: Display, R: DeserializeOwned>( &self, batch_id: T0, ) -> Result<R, OpenAIError>

Cancel a vector store file batch. This attempts to cancel the processing of files in this batch as soon as possible.

pub async fn list_files( &self, batch_id: &str, ) -> Result<ListVectorStoreFilesResponse, OpenAIError>

Returns a list of vector store files in a batch.

pub async fn list_files_byot<T0: Display, R: DeserializeOwned>( &self, batch_id: T0, ) -> Result<R, OpenAIError>

Returns a list of vector store files in a batch.

Trait Implementations

impl<'c, C: Config> RequestOptionsBuilder for VectorStoreFileBatches<'c, C>

Available on crate feature _api only.

fn options_mut(&mut self) -> &mut RequestOptions

Get mutable reference to RequestOptions (for building)

fn options(&self) -> &RequestOptions

Get reference to RequestOptions

fn headers(self, headers: HeaderMap) -> Self

Add headers to RequestOptions

fn header<K, V>(self, key: K, value: V) -> Result<Self, OpenAIError>

where K: IntoHeaderName, V: TryInto<HeaderValue>, V::Error: Into<InvalidHeaderValue>,

Add a single header to RequestOptions

fn query<Q: Serialize + ?Sized>(self, query: &Q) -> Result<Self, OpenAIError>

Add query parameters to RequestOptions

fn path<P: Into<String>>(self, path: P) -> Result<Self, OpenAIError>

Add a path to RequestOptions