Struct VectorStoreFiles 

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

Vector store files represent files inside a vector store.

Related guide: File Search

Fields

vector_store_id: String

Implementations

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

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

Available on crate feature vectorstore only.

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

Available on crate feature vectorstore only.

Create a vector store file by attaching a File to a vector store. Create a vector store file by attaching a File to a vector store.

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

Available on crate feature vectorstore only.

Create a vector store file by attaching a File to a vector store.

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

Available on crate feature vectorstore only.

Retrieves a vector store file. Retrieves a vector store file.

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

Available on crate feature vectorstore only.

Retrieves a vector store file.

pub async fn delete( &self, file_id: &str, ) -> Result<DeleteVectorStoreFileResponse, OpenAIError>

Available on crate feature vectorstore only.

Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint. Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.

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

Available on crate feature vectorstore only.

Delete a vector store file. This will remove the file from the vector store but the file itself will not be deleted. To delete the file, use the delete file endpoint.

pub async fn list(&self) -> Result<ListVectorStoreFilesResponse, OpenAIError>

Available on crate feature vectorstore only.

Returns a list of vector store files. Returns a list of vector store files.

pub async fn list_byot<R: DeserializeOwned>(&self) -> Result<R, OpenAIError>

Available on crate feature vectorstore only.

Returns a list of vector store files.

pub async fn update( &self, file_id: &str, request: UpdateVectorStoreFileAttributesRequest, ) -> Result<VectorStoreFileObject, OpenAIError>

Available on crate feature vectorstore only.

Update attributes on a vector store file. Update attributes on a vector store file.

pub async fn update_byot<T0: Display, T1: Serialize, R: DeserializeOwned>( &self, file_id: T0, request: T1, ) -> Result<R, OpenAIError>

Available on crate feature vectorstore only.

Update attributes on a vector store file.

pub async fn retrieve_file_content( &self, file_id: &str, ) -> Result<VectorStoreFileContentResponse, OpenAIError>

Available on crate feature vectorstore only.

Retrieve the parsed contents of a vector store file. Retrieve the parsed contents of a vector store file.

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

Available on crate feature vectorstore only.

Retrieve the parsed contents of a vector store file.

Trait Implementations

impl<'c, C: Config> RequestOptionsBuilder for VectorStoreFiles<'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