Struct DescribeIndexStatsResponse

pub struct DescribeIndexStatsResponse {
    pub namespaces: HashMap<String, NamespaceSummary>,
    pub dimension: u32,
    pub index_fullness: f32,
    pub total_vector_count: u32,
}

The response for the describe_index_stats operation.

Fields

namespaces: HashMap<String, NamespaceSummary>

A mapping for each namespace in the index from the namespace name to a summary of its contents. If a metadata filter expression is present, the summary will reflect only vectors matching that expression.

dimension: u32

The dimension of the indexed vectors.

index_fullness: f32

The fullness of the index, regardless of whether a metadata filter expression was passed. The granularity of this metric is 10%.

Serverless indexes scale automatically as needed, so index fullness is relevant only for pod-based indexes.

The index fullness result may be inaccurate during pod resizing; to get the status of a pod resizing process, use describe_index.

total_vector_count: u32

The total number of vectors in the index, regardless of whether a metadata filter expression was passed

Trait Implementations

impl Clone for DescribeIndexStatsResponse

fn clone(&self) -> DescribeIndexStatsResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeIndexStatsResponse

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

Formats the value using the given formatter.

impl Default for DescribeIndexStatsResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for DescribeIndexStatsResponse

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for DescribeIndexStatsResponse

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