Documentation ¶
Index ¶
- type Client
- 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
- type Collection
- type CollectionStatus
- type CreateCollectionRequest
- type CreatePodIndexRequest
- type CreateServerlessIndexRequest
- type DescribeIndexStatsResponse
- type FetchVectorsResponse
- type Filter
- type Index
- type IndexConnection
- 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
- type IndexSpec
- type IndexStatus
- type IndexStatusState
- type ListVectorsRequest
- type ListVectorsResponse
- type Metadata
- type NamespaceSummary
- type NewClientParams
- type PodSpec
- type PodSpecMetadataConfig
- type QueryByVectorIdRequest
- type QueryByVectorValuesRequest
- type QueryVectorsResponse
- type ScoredVector
- type ServerlessSpec
- type SparseValues
- type UpdateVectorRequest
- type Usage
- type Vector
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(in NewClientParams) (*Client, error)
func (*Client) CreateCollection ¶
func (c *Client) CreateCollection(ctx context.Context, in *CreateCollectionRequest) (*Collection, error)
func (*Client) CreatePodIndex ¶
func (*Client) CreateServerlessIndex ¶
func (*Client) DeleteCollection ¶
func (*Client) DeleteIndex ¶
func (*Client) DescribeCollection ¶
func (*Client) DescribeIndex ¶
func (*Client) IndexWithNamespace ¶
func (c *Client) IndexWithNamespace(host string, namespace string) (*IndexConnection, error)
func (*Client) ListCollections ¶
func (c *Client) ListCollections(ctx context.Context) ([]*Collection, error)
type Collection ¶
type CollectionStatus ¶
type CollectionStatus string
const ( CollectionStatusInitializing CollectionStatus = "Initializing" CollectionStatusReady CollectionStatus = "Ready" CollectionStatusTerminating CollectionStatus = "Terminating" )
type CreateCollectionRequest ¶
type CreatePodIndexRequest ¶
type CreatePodIndexRequest struct { Name string Dimension int32 Metric IndexMetric Environment string PodType string Shards int32 Replicas int32 SourceCollection *string MetadataConfig *PodSpecMetadataConfig }
func (CreatePodIndexRequest) ReplicaCount ¶
func (req CreatePodIndexRequest) ReplicaCount() *int32
func (CreatePodIndexRequest) ShardCount ¶
func (req CreatePodIndexRequest) ShardCount() *int32
func (CreatePodIndexRequest) TotalCount ¶
func (req CreatePodIndexRequest) TotalCount() *int
type CreateServerlessIndexRequest ¶
type CreateServerlessIndexRequest struct { Name string Dimension int32 Metric IndexMetric Cloud Cloud Region string }
type DescribeIndexStatsResponse ¶
type DescribeIndexStatsResponse struct { Dimension uint32 IndexFullness float32 TotalVectorCount uint32 Namespaces map[string]*NamespaceSummary }
type FetchVectorsResponse ¶
type Index ¶
type Index struct { Name string Dimension int32 Host string Metric IndexMetric Spec *IndexSpec Status *IndexStatus }
type IndexConnection ¶
type IndexConnection struct { Namespace string // contains filtered or unexported fields }
func (*IndexConnection) Close ¶
func (idx *IndexConnection) Close() error
func (*IndexConnection) DeleteAllVectorsInNamespace ¶
func (idx *IndexConnection) DeleteAllVectorsInNamespace(ctx *context.Context) error
func (*IndexConnection) DeleteVectorsByFilter ¶
func (idx *IndexConnection) DeleteVectorsByFilter(ctx *context.Context, filter *Filter) error
func (*IndexConnection) DeleteVectorsById ¶
func (idx *IndexConnection) DeleteVectorsById(ctx *context.Context, ids []string) error
func (*IndexConnection) DescribeIndexStats ¶
func (idx *IndexConnection) DescribeIndexStats(ctx *context.Context) (*DescribeIndexStatsResponse, error)
func (*IndexConnection) DescribeIndexStatsFiltered ¶
func (idx *IndexConnection) DescribeIndexStatsFiltered(ctx *context.Context, filter *Filter) (*DescribeIndexStatsResponse, error)
func (*IndexConnection) FetchVectors ¶
func (idx *IndexConnection) FetchVectors(ctx *context.Context, ids []string) (*FetchVectorsResponse, error)
func (*IndexConnection) ListVectors ¶
func (idx *IndexConnection) ListVectors(ctx *context.Context, in *ListVectorsRequest) (*ListVectorsResponse, error)
func (*IndexConnection) QueryByVectorId ¶
func (idx *IndexConnection) QueryByVectorId(ctx *context.Context, in *QueryByVectorIdRequest) (*QueryVectorsResponse, error)
func (*IndexConnection) QueryByVectorValues ¶
func (idx *IndexConnection) QueryByVectorValues(ctx *context.Context, in *QueryByVectorValuesRequest) (*QueryVectorsResponse, error)
func (*IndexConnection) UpdateVector ¶
func (idx *IndexConnection) UpdateVector(ctx *context.Context, in *UpdateVectorRequest) error
func (*IndexConnection) UpsertVectors ¶
type IndexMetric ¶
type IndexMetric string
const ( Cosine IndexMetric = "cosine" Dotproduct IndexMetric = "dotproduct" Euclidean IndexMetric = "euclidean" )
type IndexSpec ¶
type IndexSpec struct { Pod *PodSpec Serverless *ServerlessSpec }
type IndexStatus ¶
type IndexStatus struct { Ready bool State IndexStatusState }
type IndexStatusState ¶
type IndexStatusState string
const ( InitializationFailed IndexStatusState = "InitializationFailed" Initializing IndexStatusState = "Initializing" Ready IndexStatusState = "Ready" ScalingDown IndexStatusState = "ScalingDown" ScalingDownPodSize IndexStatusState = "ScalingDownPodSize" ScalingUp IndexStatusState = "ScalingUp" ScalingUpPodSize IndexStatusState = "ScalingUpPodSize" Terminating IndexStatusState = "Terminating" )
type ListVectorsRequest ¶
type ListVectorsResponse ¶
type NamespaceSummary ¶
type NamespaceSummary struct {
VectorCount uint32
}
type NewClientParams ¶
type PodSpecMetadataConfig ¶
type PodSpecMetadataConfig struct {
Indexed *[]string
}
type QueryByVectorIdRequest ¶
type QueryVectorsResponse ¶
type QueryVectorsResponse struct { Matches []*ScoredVector Usage *Usage }
type ScoredVector ¶
type ServerlessSpec ¶
type SparseValues ¶
type UpdateVectorRequest ¶
type UpdateVectorRequest struct { Id string Values []float32 SparseValues *SparseValues Metadata *Metadata }
Click to show internal directories.
Click to hide internal directories.