index

package
v0.0.0-...-39cdd17 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 9, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

File: provider/pkg/pinecone/index/index.go

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type IndexMetric 

type IndexMetric string

func (IndexMetric) Values 

func (IndexMetric) Values() []infer.EnumValue[IndexMetric]

type LookupPineconeCollection 

type LookupPineconeCollection struct{}

func (*LookupPineconeCollection) Annotate 

func (g *LookupPineconeCollection) Annotate(a infer.Annotator)

func (*LookupPineconeCollection) Call 

func (*LookupPineconeCollection) Call(ctx context.Context, args LookupPineconeCollectionArgs) (LookupPineconeCollectionResult, error)

type LookupPineconeCollectionArgs 

type LookupPineconeCollectionArgs struct {
	CollectionName string `pulumi:"name"`
}

func (*LookupPineconeCollectionArgs) Annotate 

func (g *LookupPineconeCollectionArgs) Annotate(a infer.Annotator)

type LookupPineconeCollectionResult 

type LookupPineconeCollectionResult struct {
	PineconeCollectionState
}

func (*LookupPineconeCollectionResult) Annotate 

func (g *LookupPineconeCollectionResult) Annotate(a infer.Annotator)

type LookupPineconeIndex 

type LookupPineconeIndex struct{}

func (*LookupPineconeIndex) Call 

func (*LookupPineconeIndex) Call(ctx context.Context, args LookupPineconeIndexArgs) (LookupPineconeIndexResult, error)

type LookupPineconeIndexArgs 

type LookupPineconeIndexArgs struct {
	IndexName string `pulumi:"name"`
}

func (*LookupPineconeIndexArgs) Annotate 

func (g *LookupPineconeIndexArgs) Annotate(a infer.Annotator)

type LookupPineconeIndexResult 

type LookupPineconeIndexResult struct {
	PineconeIndexArgs
	IndexHost    string `pulumi:"host,omitempty"`
	IndextStatus bool   `pulumi:"status,omitempty"`
}

func (*LookupPineconeIndexResult) Annotate 

func (g *LookupPineconeIndexResult) Annotate(a infer.Annotator)

type MetaDataConfig 

type MetaDataConfig struct {
	Indexed *[]string `pulumi:"indexed,optional"`
}

func (*MetaDataConfig) Annotate 

func (pim *MetaDataConfig) Annotate(a infer.Annotator)

type PineconeCollection 

type PineconeCollection struct{}

func (*PineconeCollection) Create 

func (*PineconeCollection) Create(ctx context.Context, name string, args PineconeCollectionArgs, preview bool) (string, PineconeCollectionState, error)

func (*PineconeCollection) Delete 

func (*PineconeCollection) Delete(ctx context.Context, id string, args PineconeCollectionArgs) error

func (*PineconeCollection) Read 

func (*PineconeCollection) Read(ctx context.Context, id string, args PineconeCollectionArgs, state PineconeCollectionState) (canonicalID string, normalizedInputs PineconeCollectionArgs, normalizedState PineconeCollectionState, err error)

type PineconeCollectionArgs 

type PineconeCollectionArgs struct {
	CollectionName   string `pulumi:"name"`
	CollectionSource string `pulumi:"source"`
}

func (*PineconeCollectionArgs) Annotate 

func (pc *PineconeCollectionArgs) Annotate(a infer.Annotator)

type PineconeCollectionState 

type PineconeCollectionState struct {
	PineconeCollectionArgs
	CollectionSize        *int64  `pulumi:"size"`
	CollectionDimension   *int32  `pulumi:"dimension"`
	CollectionVectorCount *int32  `pulumi:"vectorCount"`
	CollectionEnvironment *string `pulumi:"environment"`
}

func (*PineconeCollectionState) Annotate 

func (pcs *PineconeCollectionState) Annotate(a infer.Annotator)

type PineconeIndex 

type PineconeIndex struct{}

func (*PineconeIndex) Create 

func (*PineconeIndex) Create(ctx context.Context, name string, args PineconeIndexArgs, preview bool) (string, PineconeIndexState, error)

func (*PineconeIndex) Delete 

func (pi *PineconeIndex) Delete(ctx context.Context, id string, state PineconeIndexState) error

func (*PineconeIndex) Read 

func (pi *PineconeIndex) Read(ctx context.Context, id string, args PineconeIndexArgs, state PineconeIndexState) (canonicalID string, normalizedInputs PineconeIndexArgs, normalizedState PineconeIndexState, err error)

type PineconeIndexArgs 

type PineconeIndexArgs struct {
	/**
	 * IndexName specifies the unique name for the Pinecone index. This is a mandatory field and is used to
	 * identify the index in the Pinecone environment.
	 */
	IndexName string `pulumi:"name"`

	/**
	 * IndexDimension specifies the dimensions of the vectors that the index will store. It is optional and, if
	 * not provided, a default dimension may be used based on the Pinecone environment settings.
	 *
	 * Defaults to 1536.
	 */
	IndexDimension client.IndexDimension `pulumi:"dimension,omitempty,optional"`

	/**
	 * IndexMetric determines the type of metric to be used for measuring distances in the vector space. This
	 * could be, for example, Euclidean or cosine distance, depending on the IndexMetric value.
	 */
	IndexMetric IndexMetric `pulumi:"metric"`

	/**
	 * IndexSpec defines the specific configuration and settings for the Pinecone index.
	 */
	IndexSpec PineconeSpec `pulumi:"spec"`
}

PineconeIndexArgs describes the configuration options available for creating or managing a Pinecone index.

func (*PineconeIndexArgs) Annotate 

func (pip *PineconeIndexArgs) Annotate(a infer.Annotator)

type PineconeIndexState 

type PineconeIndexState struct {
	PineconeIndexArgs
	IndexHost string `pulumi:"host,omitempty"`
}

func (*PineconeIndexState) Annotate 

func (pip *PineconeIndexState) Annotate(a infer.Annotator)

type PineconePodSpec 

type PineconePodSpec struct {
	Environment      string          `pulumi:"environment"`
	Replicas         PodSpecReplicas `pulumi:"replicas"`
	Shards           PodSpecShards   `pulumi:"shards,optional,omitempty"`
	PodType          PodSpecPodType  `pulumi:"podType"`
	Pods             int             `pulumi:"pods,optional,omitempty"`
	MetaDataConfig   *MetaDataConfig `pulumi:"metaDataConfig,optional"`
	SourceCollection *string         `pulumi:"sourceCollection,optional"`
}

func (*PineconePodSpec) Annotate 

func (pip *PineconePodSpec) Annotate(a infer.Annotator)

type PineconeServerlessSpec 

type PineconeServerlessSpec struct {
	Cloud  ServerlessSpecCloud `pulumi:"cloud"`
	Region string              `pulumi:"region"`
}

func (*PineconeServerlessSpec) Annotate 

func (pip *PineconeServerlessSpec) Annotate(a infer.Annotator)

type PineconeSpec 

type PineconeSpec struct {
	Serverless *PineconeServerlessSpec `pulumi:"serverless,optional,omitempty"`
	Pod        *PineconePodSpec        `pulumi:"pod,optional,omitempty"`
}

func (*PineconeSpec) Annotate 

func (pip *PineconeSpec) Annotate(a infer.Annotator)

type PodSpecPodType 

type PodSpecPodType = string

type PodSpecReplicas 

type PodSpecReplicas = int32

type PodSpecShards 

type PodSpecShards = int32

type ServerlessSpecCloud 

type ServerlessSpecCloud string

func (ServerlessSpecCloud) Values 

func (ServerlessSpecCloud) Values() []infer.EnumValue[ServerlessSpecCloud]

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.