Skip to main content

AsyncCortexDbClient

Struct AsyncCortexDbClient 

Source
pub struct AsyncCortexDbClient { /* private fields */ }
Expand description

Async HTTP client for the CortexDB API.

Enable with the async feature:

cortex-sdk = { version = "...", features = ["async"] }

Implementations§

Source§

impl AsyncCortexDbClient

Source

pub async fn health(&self) -> SdkResult<Value>

Source

pub async fn health_response(&self) -> SdkResult<HealthResponse>

Source

pub async fn stats(&self) -> SdkResult<Value>

Source

pub async fn stats_response(&self) -> SdkResult<StatsResponse>

Source

pub async fn validate(&self) -> SdkResult<Value>

Source

pub async fn validate_response(&self) -> SdkResult<ValidationResponse>

Source

pub async fn put_cell(&self, cell_id: u64, payload: &str) -> SdkResult<Value>

Source

pub async fn put_cell_response( &self, cell_id: u64, payload: &str, ) -> SdkResult<PutCellResponse>

Source

pub async fn write_batch(&self, request: &WriteBatchRequest) -> SdkResult<Value>

Source

pub async fn write_batch_response( &self, request: &WriteBatchRequest, ) -> SdkResult<WriteBatchResponse>

Source

pub async fn get_cell(&self, cell_id: u64) -> SdkResult<Value>

Source

pub async fn get_cell_response( &self, cell_id: u64, ) -> SdkResult<CellLookupResponse>

Source

pub async fn tombstone_cell(&self, cell_id: u64) -> SdkResult<Value>

Source

pub async fn flush(&self) -> SdkResult<Value>

Source

pub async fn compact(&self) -> SdkResult<Value>

Source§

impl AsyncCortexDbClient

Source

pub async fn ingest_text( &self, scope: &str, source: &str, text: &str, ) -> SdkResult<Value>

Source

pub async fn ingest_text_response( &self, scope: &str, source: &str, text: &str, ) -> SdkResult<IngestResponse>

Source

pub async fn ingest_json( &self, scope: &str, source: &str, document: &str, ) -> SdkResult<Value>

Source

pub async fn ingest_json_response( &self, scope: &str, source: &str, document: &str, ) -> SdkResult<IngestResponse>

Source

pub async fn ingest_csv( &self, scope: &str, source: &str, document: &str, ) -> SdkResult<Value>

Source

pub async fn ingest_csv_response( &self, scope: &str, source: &str, document: &str, ) -> SdkResult<IngestResponse>

Source

pub async fn ingestion_job(&self, job_id: u64) -> SdkResult<Value>

Source

pub async fn ingestion_job_response( &self, job_id: u64, ) -> SdkResult<IngestionJobResponse>

Source

pub async fn delete_ingestion_job( &self, job_id: u64, ) -> SdkResult<DeleteJobResponse>

Source

pub async fn retry_ingestion_job( &self, job_id: u64, ) -> SdkResult<IngestionJobResponse>

Source§

impl AsyncCortexDbClient

Source

pub async fn aql(&self, scope: &str, statement: &str) -> SdkResult<Value>

Source

pub async fn aql_response( &self, scope: &str, statement: &str, ) -> SdkResult<AqlResponse>

Source

pub async fn context(&self, scope: &str, statement: &str) -> SdkResult<Value>

Source

pub async fn context_response( &self, scope: &str, statement: &str, ) -> SdkResult<ContextPackResponse>

Source

pub async fn context_prompt( &self, scope: &str, statement: &str, ) -> SdkResult<String>

Source

pub async fn context_markdown( &self, scope: &str, statement: &str, ) -> SdkResult<String>

Source

pub async fn verify(&self, scope: &str, statement: &str) -> SdkResult<Value>

Source

pub async fn verify_response( &self, scope: &str, statement: &str, ) -> SdkResult<VerificationReportResponse>

Source

pub async fn verify_request_response( &self, request: &VerifyRequest, ) -> SdkResult<VerificationReportResponse>

Source

pub async fn verify_request_export( &self, request: &VerifyRequest, ) -> SdkResult<String>

Source

pub async fn answer_with_grounded_context<F, Fut>( &self, request: GroundedAnswerRequest, answerer: F, ) -> SdkResult<GroundedAnswerResponse>
where F: FnOnce(&ContextPackResponse) -> Fut, Fut: Future<Output = SdkResult<String>>,

Source

pub async fn remember(&self, scope: &str, statement: &str) -> SdkResult<Value>

Source

pub async fn remember_response( &self, scope: &str, statement: &str, ) -> SdkResult<RememberResponse>

Source§

impl AsyncCortexDbClient

Source

pub async fn search_keyword( &self, scope: &str, query: &str, limit: usize, ) -> SdkResult<Value>

Source

pub async fn search_keyword_response( &self, scope: &str, query: &str, limit: usize, ) -> SdkResult<SearchResponse>

Source

pub async fn search_auto( &self, scope: &str, query: &str, vector: Option<&str>, limit: usize, ) -> SdkResult<Value>

Source

pub async fn search_auto_response( &self, scope: &str, query: &str, vector: Option<&str>, limit: usize, ) -> SdkResult<SearchResponse>

Source

pub async fn search_explain( &self, scope: &str, query: &str, mode: &str, vector: Option<&str>, limit: usize, ) -> SdkResult<Value>

Source

pub async fn search_explain_response( &self, scope: &str, query: &str, mode: &str, vector: Option<&str>, limit: usize, ) -> SdkResult<SearchExplainResponse>

Source

pub async fn search_vector( &self, scope: &str, vector: &[i16], algorithm: VectorAlgorithm, limit: usize, ) -> SdkResult<Value>

Source

pub async fn search_vector_response( &self, scope: &str, vector: &[i16], algorithm: VectorAlgorithm, limit: usize, ) -> SdkResult<SearchResponse>

Source

pub async fn evaluate_ann( &self, scope: &str, vector: &[i16], limit: usize, ) -> SdkResult<Value>

Source

pub async fn evaluate_ann_response( &self, scope: &str, vector: &[i16], limit: usize, ) -> SdkResult<AnnEvaluationResponse>

Source§

impl AsyncCortexDbClient

Source

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

Create an async client with the default 10-second per-request timeout.

Source

pub fn with_timeout(base_url: impl Into<String>, timeout: Duration) -> Self

Create an async client with a custom per-request timeout.

Source

pub fn with_token(self, token: impl Into<String>) -> Self

Set the Bearer token for authenticated requests.

Source

pub fn with_tenant(self, tenant: impl Into<String>) -> Self

Set the tenant ID for per-tenant database routing.

Source

pub fn with_retries(self, max_retries: u32, retry_delay: Duration) -> Self

Set retry behaviour for transient requests.

Trait Implementations§

Source§

impl Clone for AsyncCortexDbClient

Source§

fn clone(&self) -> AsyncCortexDbClient

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AsyncCortexDbClient

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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: Sized + 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: Sized + 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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