Struct VectorsApi

Source
pub struct VectorsApi<'a>(/* private fields */);
Expand description

VectorsApi struct to interact with vector stores API endpoints.

Implementations§

Source§

impl<'a> VectorsApi<'a>

Source

pub async fn create_vector_store( &self, request: VectorStoreCreationRequest, ) -> OpenAIResult<Value>

Create a new vector store using the provided request parameters.

§Arguments
§Returns

A Result containing the JSON response as serde_json::Value on success, or an OpenAIError on failure.

Source

pub async fn list_vector_stores( &self, limit: Option<u64>, order: Option<String>, after: Option<String>, before: Option<String>, ) -> OpenAIResult<Value>

List vector stores with optional query parameters.

§Arguments
  • limit - Maximum number of vector stores to retrieve.
  • order - Order of the retrieved vector stores.
  • after - Retrieve vector stores created after this ID.
  • before - Retrieve vector stores created before this ID.
§Returns

A Result containing the JSON response as serde_json::Value on success, or an OpenAIError on failure.

Source

pub async fn retrieve_vector_store( &self, vector_store_id: &str, ) -> OpenAIResult<Value>

Retrieve details of a specific vector store.

§Arguments
  • vector_store_id - The ID of the vector store to retrieve.
§Returns

A Result containing the JSON response as serde_json::Value on success, or an OpenAIError on failure.

Source

pub async fn modify_vector_store( &self, vector_store_id: &str, request: VectorStoreModificationRequest, ) -> OpenAIResult<Value>

Modify an existing vector store using the provided request parameters.

§Arguments
  • vector_store_id - The ID of the vector store to modify.
  • request - A VectorStoreModificationRequest containing the parameters for the vector store modification.
§Returns

A Result containing the JSON response as serde_json::Value on success, or an OpenAIError on failure.

Source

pub async fn delete_vector_store( &self, vector_store_id: &str, ) -> OpenAIResult<Value>

Delete a specific vector store.

§Arguments
  • vector_store_id - The ID of the vector store to delete.
§Returns

A Result containing the JSON response as serde_json::Value on success, or an OpenAIError on failure.

Auto Trait Implementations§

§

impl<'a> Freeze for VectorsApi<'a>

§

impl<'a> !RefUnwindSafe for VectorsApi<'a>

§

impl<'a> Send for VectorsApi<'a>

§

impl<'a> Sync for VectorsApi<'a>

§

impl<'a> Unpin for VectorsApi<'a>

§

impl<'a> !UnwindSafe for VectorsApi<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,