IPineconeClient.DescribeIndexAsync(String, CancellationToken) Method
Definition
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
public System.Threading.Tasks.Task<Microsoft.SemanticKernel.Connectors.Pinecone.PineconeIndex?> DescribeIndexAsync (string indexName, System.Threading.CancellationToken cancellationToken = default);abstract member DescribeIndexAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.SemanticKernel.Connectors.Pinecone.PineconeIndex>Public Function DescribeIndexAsync (indexName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of PineconeIndex)Parameters
- indexName
- String
the name of the index.
- cancellationToken
- CancellationToken
Cancellation Token to cancel the request.
Returns
Task of Index
Remarks
Get a description of an index.