IndexDefinition Class

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.

Used to create a new index. See https://docs.pinecone.io/reference/create_index

public class IndexDefinition

type IndexDefinition = class

Public Class IndexDefinition

Inheritance: Object
IndexDefinition

Constructors

IndexDefinition(String)

Initializes a new instance of the IndexDefinition class.

Properties

Dimension	The number of dimensions in the vector representation
MetadataConfig	The metadata index configuration.
Metric	The index metric to use for similarity search.
Name	The unique name of an index.
Pods	The number of pods for the index to use, including replicas.
PodType	The type of pod to use for the index.
Replicas	The number of replicas. Replicas duplicate index. They provide higher availability and throughput.
Shards	The numbers of shards for the index to use.
SourceCollection	The unique name of a collection.

Methods

Build()	Initializes a new instance of the HttpRequestMessage class with request body of IndexDefinition.
Create(String)	Initializes a new instance of the IndexDefinition class.
Default(String)	Initializes a new instance of the IndexDefinition class with default settings.
FromSourceCollection(String)	Sets source collection for IndexDefinition instance.
NumberOfPods(Int32)	Sets pods for IndexDefinition instance.
NumberOfReplicas(Int32)	Sets number of replicas for IndexDefinition instance.
ToString()	Returns a string that represents the current object.
WithDimension(Int32)	Sets dimension for IndexDefinition instance.
WithMetadataIndex(MetadataIndexConfig)	Sets metadata index configuration for IndexDefinition instance.
WithMetric(IndexMetric)	Sets metric for IndexDefinition instance.
WithPodType(PodType)	Sets pod type for IndexDefinition instance.

Applies to

Share via