io.pinecone.proto

Interface DescribeIndexStatsResponseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DescribeIndexStatsResponse, DescribeIndexStatsResponse.Builder

public interface DescribeIndexStatsResponseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsNamespaces(java.lang.String key) A mapping for each namespace in the index from the namespace name to a summary of its contents.
int	getDimension() The dimension of the indexed vectors.
float	getIndexFullness() The fullness of the index, regardless of whether a metadata filter expression was passed.
java.util.Map<java.lang.String,NamespaceSummary>	getNamespaces() Deprecated.
int	getNamespacesCount() A mapping for each namespace in the index from the namespace name to a summary of its contents.
java.util.Map<java.lang.String,NamespaceSummary>	getNamespacesMap() A mapping for each namespace in the index from the namespace name to a summary of its contents.
NamespaceSummary	getNamespacesOrDefault(java.lang.String key, NamespaceSummary defaultValue) A mapping for each namespace in the index from the namespace name to a summary of its contents.
NamespaceSummary	getNamespacesOrThrow(java.lang.String key) A mapping for each namespace in the index from the namespace name to a summary of its contents.
int	getTotalVectorCount() The total number of vectors in the index, regardless of whether a metadata filter expression was passed

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getNamespacesCount

int getNamespacesCount()

 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.
 

map<string, .NamespaceSummary> namespaces = 1;

containsNamespaces

boolean containsNamespaces(java.lang.String key)

 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.
 

map<string, .NamespaceSummary> namespaces = 1;

getNamespaces

@Deprecated
java.util.Map<java.lang.String,NamespaceSummary> getNamespaces()

Deprecated.

Use getNamespacesMap() instead.

getNamespacesMap

java.util.Map<java.lang.String,NamespaceSummary> getNamespacesMap()

 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.
 

map<string, .NamespaceSummary> namespaces = 1;

getNamespacesOrDefault

NamespaceSummary getNamespacesOrDefault(java.lang.String key,
                                        NamespaceSummary defaultValue)

 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.
 

map<string, .NamespaceSummary> namespaces = 1;

getNamespacesOrThrow

NamespaceSummary getNamespacesOrThrow(java.lang.String key)

 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.
 

map<string, .NamespaceSummary> namespaces = 1;

getDimension

int getDimension()

 The dimension of the indexed vectors.
 

uint32 dimension = 2;

Returns:

The dimension.

getIndexFullness

float getIndexFullness()

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

float index_fullness = 3;

Returns:

The indexFullness.

getTotalVectorCount

int getTotalVectorCount()

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

uint32 total_vector_count = 4;

Returns:

The totalVectorCount.