pinecone

package

Go to main page

Versions in this module

v1

v1.1.1

Sep 18, 2024

Changes in this version

type Vector

+ func GenerateVectors(numOfVectors int, dimension int32, isSparse bool) []*Vector

v1.1.0

Aug 23, 2024

Changes in this version

+ func WaitUntilIndexReady(ts *IntegrationTests, ctx context.Context) (bool, error)

type Client

+ Inference *InferenceService

+ type EmbedParameters struct

+ InputType string

+ Truncate string

+ type EmbedRequest struct

+ Model string

+ Parameters EmbedParameters

+ TextInputs []string

+ type InferenceService struct

+ func (i *InferenceService) Embed(ctx context.Context, in *EmbedRequest) (*control.EmbeddingsList, error)

v1.0.0

Aug 6, 2024

Changes in this version

+ func GenerateTestIndexName() string

+ func GetIndexStatus(ts *IntegrationTests, ctx context.Context) (bool, error)

type Client

+ func (c *Client) ConfigureIndex(ctx context.Context, name string, in ConfigureIndexParams) (*Index, error)

+ type ConfigureIndexParams struct

+ DeletionProtection DeletionProtection

+ PodType string

+ Replicas int32

type CreatePodIndexRequest

+ DeletionProtection DeletionProtection

type CreateServerlessIndexRequest

+ DeletionProtection DeletionProtection

+ type DeletionProtection string

+ const DeletionProtectionDisabled

+ const DeletionProtectionEnabled

type FetchVectorsResponse

+ Namespace string

type Index

+ DeletionProtection DeletionProtection

+ func BuildPodTestIndex(in *Client, name string) *Index

+ func BuildServerlessTestIndex(in *Client, idxName string) *Index

+ type IntegrationTests struct

+ func (ts *IntegrationTests) SetupSuite()

+ func (ts *IntegrationTests) TearDownSuite()

type ListVectorsResponse

+ Namespace string

+ type MetadataFilter = structpb.Struct

+ type NewIndexConnParams struct

+ AdditionalMetadata map[string]string

+ Host string

+ Namespace string

type QueryByVectorValuesRequest

+ MetadataFilter *MetadataFilter

type QueryVectorsResponse

+ Namespace string

v0

v0.5.0

Jun 8, 2024

Changes in this version

+ func PrettifyStruct(obj interface{}) string

type Client

+ func NewClientBase(in NewClientBaseParams) (*Client, error)

+ func (c *Client) IndexWithAdditionalMetadata(host string, namespace string, additionalMetadata map[string]string) (*IndexConnection, error)

+ type NewClientBaseParams struct

+ Headers map[string]string

+ Host string

+ RestClient *http.Client

+ SourceTag string

type NewClientParams

+ Headers map[string]string

+ Host string

+ RestClient *http.Client

+ type PineconeError struct

+ Code int

+ Msg error

+ func (pe *PineconeError) Error() string

v0.4.1

Mar 27, 2024

Changes in this version

type NewClientParams

+ SourceTag string

v0.4.0

Mar 15, 2024

Changes in this version

+ type Client struct

+ func NewClient(in NewClientParams) (*Client, error)

+ func (c *Client) CreateCollection(ctx context.Context, in *CreateCollectionRequest) (*Collection, error)

+ func (c *Client) CreatePodIndex(ctx context.Context, in *CreatePodIndexRequest) (*Index, error)

+ func (c *Client) CreateServerlessIndex(ctx context.Context, in *CreateServerlessIndexRequest) (*Index, error)

+ func (c *Client) DeleteCollection(ctx context.Context, collectionName string) error

+ func (c *Client) DeleteIndex(ctx context.Context, idxName string) error

+ func (c *Client) DescribeCollection(ctx context.Context, collectionName string) (*Collection, error)

+ func (c *Client) DescribeIndex(ctx context.Context, idxName string) (*Index, error)

+ func (c *Client) Index(host string) (*IndexConnection, error)

+ func (c *Client) IndexWithNamespace(host string, namespace string) (*IndexConnection, error)

+ func (c *Client) ListCollections(ctx context.Context) ([]*Collection, error)

+ func (c *Client) ListIndexes(ctx context.Context) ([]*Index, error)

+ type Cloud string

+ const Aws

+ const Azure

+ const Gcp

+ type Collection struct

+ Dimension *int32

+ Environment string

+ Name string

+ Size *int64

+ Status CollectionStatus

+ VectorCount *int32

+ type CollectionStatus string

+ const CollectionStatusInitializing

+ const CollectionStatusReady

+ const CollectionStatusTerminating

+ type CreateCollectionRequest struct

+ Name string

+ Source string

+ type CreatePodIndexRequest struct

+ Dimension int32

+ Environment string

+ MetadataConfig *PodSpecMetadataConfig

+ Metric IndexMetric

+ Name string

+ PodType string

+ Replicas int32

+ Shards int32

+ SourceCollection *string

+ func (req CreatePodIndexRequest) ReplicaCount() *int32

+ func (req CreatePodIndexRequest) ShardCount() *int32

+ func (req CreatePodIndexRequest) TotalCount() *int

+ type CreateServerlessIndexRequest struct

+ Cloud Cloud

+ Dimension int32

+ Metric IndexMetric

+ Name string

+ Region string

+ type DescribeIndexStatsResponse struct

+ Dimension uint32

+ IndexFullness float32

+ Namespaces map[string]*NamespaceSummary

+ TotalVectorCount uint32

+ type FetchVectorsResponse struct

+ Usage *Usage

+ Vectors map[string]*Vector

+ type Filter = structpb.Struct

+ type Index struct

+ Dimension int32

+ Host string

+ Metric IndexMetric

+ Name string

+ Spec *IndexSpec

+ Status *IndexStatus

+ type IndexConnection struct

+ Namespace string

+ func (idx *IndexConnection) Close() error

+ func (idx *IndexConnection) DeleteAllVectorsInNamespace(ctx *context.Context) error

+ func (idx *IndexConnection) DeleteVectorsByFilter(ctx *context.Context, filter *Filter) error

+ func (idx *IndexConnection) DeleteVectorsById(ctx *context.Context, ids []string) error

+ func (idx *IndexConnection) DescribeIndexStats(ctx *context.Context) (*DescribeIndexStatsResponse, error)

+ func (idx *IndexConnection) DescribeIndexStatsFiltered(ctx *context.Context, filter *Filter) (*DescribeIndexStatsResponse, error)

+ func (idx *IndexConnection) FetchVectors(ctx *context.Context, ids []string) (*FetchVectorsResponse, error)

+ func (idx *IndexConnection) ListVectors(ctx *context.Context, in *ListVectorsRequest) (*ListVectorsResponse, error)

+ func (idx *IndexConnection) QueryByVectorId(ctx *context.Context, in *QueryByVectorIdRequest) (*QueryVectorsResponse, error)

+ func (idx *IndexConnection) QueryByVectorValues(ctx *context.Context, in *QueryByVectorValuesRequest) (*QueryVectorsResponse, error)

+ func (idx *IndexConnection) UpdateVector(ctx *context.Context, in *UpdateVectorRequest) error

+ func (idx *IndexConnection) UpsertVectors(ctx *context.Context, in []*Vector) (uint32, error)

+ type IndexMetric string

+ const Cosine

+ const Dotproduct

+ const Euclidean

+ type IndexSpec struct

+ Pod *PodSpec

+ Serverless *ServerlessSpec

+ type IndexStatus struct

+ Ready bool

+ State IndexStatusState

+ type IndexStatusState string

+ const InitializationFailed

+ const Initializing

+ const Ready

+ const ScalingDown

+ const ScalingDownPodSize

+ const ScalingUp

+ const ScalingUpPodSize

+ const Terminating

+ type ListVectorsRequest struct

+ Limit *uint32

+ PaginationToken *string

+ Prefix *string

+ type ListVectorsResponse struct

+ NextPaginationToken *string

+ Usage *Usage

+ VectorIds []*string

+ type Metadata = structpb.Struct

+ type NamespaceSummary struct

+ VectorCount uint32

+ type NewClientParams struct

+ ApiKey string

+ type PodSpec struct

+ Environment string

+ MetadataConfig *PodSpecMetadataConfig

+ PodCount int32

+ PodType string

+ Replicas int32

+ ShardCount int32

+ SourceCollection *string

+ type PodSpecMetadataConfig struct

+ Indexed *[]string

+ type QueryByVectorIdRequest struct

+ Filter *Filter

+ IncludeMetadata bool

+ IncludeValues bool

+ SparseValues *SparseValues

+ TopK uint32

+ VectorId string

+ type QueryByVectorValuesRequest struct

+ Filter *Filter

+ IncludeMetadata bool

+ IncludeValues bool

+ SparseValues *SparseValues

+ TopK uint32

+ Vector []float32

+ type QueryVectorsResponse struct

+ Matches []*ScoredVector

+ Usage *Usage

+ type ScoredVector struct

+ Score float32

+ Vector *Vector

+ type ServerlessSpec struct

+ Cloud Cloud

+ Region string

+ type SparseValues struct

+ Indices []uint32

+ Values []float32

+ type UpdateVectorRequest struct

+ Id string

+ Metadata *Metadata

+ SparseValues *SparseValues

+ Values []float32

+ type Usage struct

+ ReadUnits *uint32

+ type Vector struct

+ Id string

+ Metadata *Metadata

+ SparseValues *SparseValues

+ Values []float32

v0.2.3

Aug 13, 2021

v0.2.2

Aug 13, 2021

v0.2.1

Jul 29, 2021

v0.2.0

Jun 3, 2021

v0.1.5

May 25, 2021

v0.1.4

May 12, 2021

v0.1.3

May 10, 2021

Other modules containing this package

github.com/pinecone-io/go-pinecone/v2

github.com/pinecone-io/go-pinecone/v3

github.com/pinecone-io/go-pinecone/v4

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL