IPineconeClient.DescribeIndexStatsAsync Method

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.Pinecone

Assembly:: Microsoft.SemanticKernel.Connectors.Pinecone.dll

Package:: Microsoft.SemanticKernel.Connectors.Pinecone v1.20.0-alpha

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Describe Index Stats

public System.Threading.Tasks.Task<Microsoft.SemanticKernel.Connectors.Pinecone.IndexStats?> DescribeIndexStatsAsync (string indexName, System.Collections.Generic.Dictionary<string,object>? filter = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DescribeIndexStatsAsync : string * System.Collections.Generic.Dictionary<string, obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.SemanticKernel.Connectors.Pinecone.IndexStats>

Public Function DescribeIndexStatsAsync (indexName As String, Optional filter As Dictionary(Of String, Object) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IndexStats)

Parameters

indexName: String

the name of the index

filter: Dictionary<String,Object>

a filter to use

cancellationToken: CancellationToken

Cancellation Token to cancel the request.

Returns

Task<IndexStats>

the index stats

Remarks

The DescribeIndexStats operation returns statistics about the index's contents, including the vector count per namespace and the number of dimensions.

Applies to

Partager via