vectors

package
v1.3.0 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BucketLoggingStatus

type BucketLoggingStatus = oss.BucketLoggingStatus

type DeleteBucketLoggingRequest

type DeleteBucketLoggingRequest = oss.DeleteBucketLoggingRequest

type DeleteBucketLoggingResult

type DeleteBucketLoggingResult = oss.DeleteBucketLoggingResult

type DeleteBucketPolicyRequest

type DeleteBucketPolicyRequest = oss.DeleteBucketPolicyRequest

type DeleteBucketPolicyResult

type DeleteBucketPolicyResult = oss.DeleteBucketPolicyResult

type DeleteVectorBucketRequest

type DeleteVectorBucketRequest struct {
	// The name of the bucket to delete.
	Bucket *string `input:"host,bucket,required"`

	oss.RequestCommon
}

type DeleteVectorBucketResult

type DeleteVectorBucketResult struct {
	oss.ResultCommon
}

type DeleteVectorIndexRequest

type DeleteVectorIndexRequest struct {
	// The name of the vector bucket.
	Bucket *string `input:"host,bucket,required"`

	IndexName *string `input:"body,indexName,json,required"`

	oss.RequestCommon
}

type DeleteVectorIndexResult

type DeleteVectorIndexResult struct {
	oss.ResultCommon
}

type DeleteVectorsRequest

type DeleteVectorsRequest struct {
	// The name of the vector bucket.
	Bucket    *string  `input:"host,bucket,required"`
	IndexName *string  `input:"body,indexName,json,required"`
	Keys      []string `input:"body,keys,json,required"`

	oss.RequestCommon
}

type DeleteVectorsResult

type DeleteVectorsResult struct {
	oss.ResultCommon
}

type GetBucketLoggingRequest

type GetBucketLoggingRequest = oss.GetBucketLoggingRequest

type GetBucketLoggingResult

type GetBucketLoggingResult = oss.GetBucketLoggingResult

type GetBucketPolicyRequest

type GetBucketPolicyRequest = oss.GetBucketPolicyRequest

type GetBucketPolicyResult

type GetBucketPolicyResult = oss.GetBucketPolicyResult

type GetVectorBucketRequest

type GetVectorBucketRequest struct {
	// The name of the bucket containing the objects
	Bucket *string `input:"host,bucket,required"`

	oss.RequestCommon
}

type GetVectorBucketResult

type GetVectorBucketResult struct {
	// The container that stores the bucket information.
	BucketInfo *VectorBucketInfo `output:"body,BucketInfo,json"`

	oss.ResultCommon
}

type GetVectorIndexRequest

type GetVectorIndexRequest struct {
	// The name of the vector bucket.
	Bucket *string `input:"host,bucket,required"`

	IndexName *string `input:"body,indexName,json,required"`

	oss.RequestCommon
}

type GetVectorIndexResult

type GetVectorIndexResult struct {
	Index *VectorIndex `json:"index"`

	oss.ResultCommon
}

type GetVectorsRequest

type GetVectorsRequest struct {
	// The name of the vector bucket.
	Bucket *string `input:"host,bucket,required"`

	IndexName      *string  `input:"body,indexName,json,required"`
	Keys           []string `input:"body,keys,json,required"`
	ReturnData     *bool    `input:"body,returnData,json"`
	ReturnMetadata *bool    `input:"body,returnMetadata,json"`

	oss.RequestCommon
}

type GetVectorsResult

type GetVectorsResult struct {
	Vectors []map[string]any `json:"vectors"`

	oss.ResultCommon
}

type ListVectorBucketsPaginator

type ListVectorBucketsPaginator struct {
	// contains filtered or unexported fields
}

ListVectorBucketsPaginator is a paginator for ListVectorBuckets

func (*ListVectorBucketsPaginator) HasNext

func (p *ListVectorBucketsPaginator) HasNext() bool

HasNext Returns true if there’s a next page.

func (*ListVectorBucketsPaginator) NextPage

func (p *ListVectorBucketsPaginator) NextPage(ctx context.Context, optFns ...func(*oss.Options)) (*ListVectorBucketsResult, error)

NextPage retrieves the next ListVectorBuckets page.

type ListVectorBucketsRequest

type ListVectorBucketsRequest struct {
	// The name of the bucket from which the list operation begins.
	Marker *string `input:"query,marker"`

	// The maximum number of buckets that can be returned in the single query.
	// Valid values: 1 to 1000.
	MaxKeys int32 `input:"query,max-keys"`

	// The prefix that the names of returned buckets must contain.
	Prefix *string `input:"query,prefix"` // Limits the response to keys that begin with the specified prefix

	// The ID of the resource group.
	ResourceGroupId *string `input:"header,x-oss-resource-group-id"`

	oss.RequestCommon
}

type ListVectorBucketsResult

type ListVectorBucketsResult struct {
	// The prefix contained in the names of the returned bucket.
	Prefix *string `json:"Prefix"`

	// The name of the bucket after which the ListVectorBuckets  operation starts.
	Marker *string `json:"Marker"` // The marker filter.

	// The maximum number of buckets that can be returned for the request.
	MaxKeys int32 `json:"MaxKeys"`

	// Indicates whether all results are returned.
	// true: Only part of the results are returned for the request.
	// false: All results are returned for the request.
	IsTruncated bool `json:"IsTruncated"`

	// The marker for the next ListVectorBuckets request, which can be used to return the remaining results.
	NextMarker *string `json:"NextMarker"`

	// The container that stores information about buckets.
	Buckets []VectorBucketProperties `json:"Buckets"`

	oss.ResultCommon
}

type ListVectorIndexesPaginator

type ListVectorIndexesPaginator struct {
	// contains filtered or unexported fields
}

ListVectorIndexesPaginator is a paginator for ListVectorIndexes

func (*ListVectorIndexesPaginator) HasNext

func (p *ListVectorIndexesPaginator) HasNext() bool

HasNext Returns true if there’s a next page.

func (*ListVectorIndexesPaginator) NextPage

func (p *ListVectorIndexesPaginator) NextPage(ctx context.Context, optFns ...func(*oss.Options)) (*ListVectorIndexesResult, error)

NextPage retrieves the next ListVectorIndexes page.

type ListVectorIndexesRequest

type ListVectorIndexesRequest struct {
	// The name of the vector bucket.
	Bucket *string `input:"host,bucket,required"`

	NextToken *string `input:"body,nextToken,json"`

	// The maximum number of indexes that can be returned.
	MaxResults int `input:"body,maxResults,json"`

	// The prefix that the names of returned indexes must contain.
	Prefix *string `input:"body,prefix,json"`

	oss.RequestCommon
}

type ListVectorIndexesResult

type ListVectorIndexesResult struct {
	// The marker for the next ListVectorIndexes request, which can be used to return the remaining results.
	NextToken *string `json:"NextToken"`

	// The container that stores information about indexes.
	Indexes []VectorIndex `json:"Indexes"`

	oss.ResultCommon
}

type ListVectorsPaginator

type ListVectorsPaginator struct {
	// contains filtered or unexported fields
}

ListVectorsPaginator is a paginator for ListVectors

func (*ListVectorsPaginator) HasNext

func (p *ListVectorsPaginator) HasNext() bool

HasNext Returns true if there’s a next page.

func (*ListVectorsPaginator) NextPage

func (p *ListVectorsPaginator) NextPage(ctx context.Context, optFns ...func(*oss.Options)) (*ListVectorsResult, error)

NextPage retrieves the next ListVectors page.

type ListVectorsRequest

type ListVectorsRequest struct {
	// The name of the vector bucket.
	Bucket *string `input:"host,bucket,required"`

	IndexName *string `input:"body,indexName,json,required"`

	// The maximum number of indexes that can be returned.
	MaxResults int `input:"body,maxResults,json"`

	NextToken *string `input:"body,nextToken,json"`

	ReturnData *bool `input:"body,returnData,json"`

	ReturnMetadata *bool `input:"body,returnMetadata,json"`

	SegmentCount *int `input:"body,segmentCount,json"`

	SegmentIndex *int `input:"body,segmentIndex,json"`

	oss.RequestCommon
}

type ListVectorsResult

type ListVectorsResult struct {
	// The marker for the next ListVectors request, which can be used to return the remaining results.
	NextToken *string `json:"NextToken"`

	// The container that stores information about vector.
	Vectors []map[string]any `json:"Vectors"`

	oss.ResultCommon
}

type LoggingEnabled

type LoggingEnabled = oss.LoggingEnabled

type PutBucketLoggingRequest

type PutBucketLoggingRequest = oss.PutBucketLoggingRequest

type PutBucketLoggingResult

type PutBucketLoggingResult = oss.PutBucketLoggingResult

type PutBucketPolicyRequest

type PutBucketPolicyRequest = oss.PutBucketPolicyRequest

type PutBucketPolicyResult

type PutBucketPolicyResult = oss.PutBucketPolicyResult

type PutVectorBucketRequest

type PutVectorBucketRequest struct {
	// The name of the bucket to create.
	Bucket *string `input:"host,bucket,required"`

	// The ID of the resource group.
	ResourceGroupId *string `input:"header,x-oss-resource-group-id"`

	// The tagging of the bucket.
	Tagging *string `input:"header,x-oss-bucket-tagging"`

	oss.RequestCommon
}

type PutVectorBucketResult

type PutVectorBucketResult struct {
	oss.ResultCommon
}

type PutVectorIndexRequest

type PutVectorIndexRequest struct {
	// The name of the vector bucket.
	Bucket         *string        `input:"host,bucket,required"`
	IndexName      *string        `input:"body,indexName,json,required"`
	DataType       *string        `input:"body,dataType,json,required"`
	Dimension      *int           `input:"body,dimension,json,required"`
	DistanceMetric *string        `input:"body,distanceMetric,json,required"`
	Metadata       map[string]any `input:"body,metadata,json"`

	oss.RequestCommon
}

type PutVectorIndexResult

type PutVectorIndexResult struct {
	oss.ResultCommon
}

type PutVectorsRequest

type PutVectorsRequest struct {
	// The name of the vector bucket.
	Bucket *string `input:"host,bucket,required"`

	IndexName *string `input:"body,indexName,json,required"`

	Vectors []map[string]any `input:"body,vectors,json,required"`

	oss.RequestCommon
}

type PutVectorsResult

type PutVectorsResult struct {
	oss.ResultCommon
}

type QueryVectorsRequest

type QueryVectorsRequest struct {
	// The name of the vector bucket.
	Bucket         *string        `input:"host,bucket,required"`
	IndexName      *string        `input:"body,indexName,json,required"`
	QueryVector    map[string]any `input:"body,queryVector,json,required"`
	TopK           *int           `input:"body,topK,json,required"`
	Filter         any            `input:"body,filter,json"`
	ReturnDistance *bool          `input:"body,returnDistance,json"`
	ReturnMetadata *bool          `input:"body,returnMetadata,json"`

	oss.RequestCommon
}

type QueryVectorsResult

type QueryVectorsResult struct {
	Vectors []map[string]any `json:"vectors"`

	oss.ResultCommon
}

type VectorBucketInfo

type VectorBucketInfo struct {
	// The name of the bucket.
	Name *string `json:"Name"`

	// The region in which the bucket is located.
	Location *string `json:"Location"`

	// The time when the bucket is created. The time is in UTc.client.
	CreationDate *time.Time `json:"CreationDate"`

	// The public endpoint that is used to access the bucket over the Internet.
	ExtranetEndpoint *string `json:"ExtranetEndpoint"`

	// The internal endpoint that is used to access the bucket from Elastic
	IntranetEndpoint *string `json:"IntranetEndpoint"`

	// The ID of the resource group to which the bucket belongs.
	ResourceGroupId *string `json:"ResourceGroupId"`
}

VectorBucketInfo defines Bucket information

type VectorBucketProperties

type VectorBucketProperties struct {
	// The name of the bucket.
	Name *string `json:"Name"`

	// The data center in which the bucket is located.
	Location *string `json:"Location"`

	// The time when the bucket was created. Format: yyyy-mm-ddThh:mm:ss.timezone.
	CreationDate *time.Time `json:"CreationDate"`

	// The public endpoint used to access the bucket over the Internet.
	ExtranetEndpoint *string `json:"ExtranetEndpoint"`

	// The internal endpoint that is used to access the bucket from ECS instances
	// that reside in the same region as the bucket.
	IntranetEndpoint *string `json:"IntranetEndpoint"`

	// The region in which the bucket is located.
	Region *string `json:"Region"`

	// The ID of the resource group to which the bucket belongs.
	ResourceGroupId *string `json:"ResourceGroupId"`
}

type VectorIndex

type VectorIndex struct {
	CreateTime       *time.Time     `json:"createTime"`
	DataType         *string        `json:"dataType"`
	Dimension        *int           `json:"dimension"`
	DistanceMetric   *string        `json:"distanceMetric"`
	IndexName        *string        `json:"indexName"`
	Metadata         map[string]any `json:"metadata"`
	Status           *string        `json:"status"`
	VectorBucketName *string        `json:"vectorBucketName"`
}

type VectorsClient

type VectorsClient struct {
	// contains filtered or unexported fields
}

func NewVectorsClient

func NewVectorsClient(cfg *oss.Config, optFns ...func(*oss.Options)) *VectorsClient

func (*VectorsClient) DeleteBucketLogging

func (c *VectorsClient) DeleteBucketLogging(ctx context.Context, request *DeleteBucketLoggingRequest, optFns ...func(*oss.Options)) (*DeleteBucketLoggingResult, error)

DeleteBucketLogging Disables the logging feature for a vector bucket.

func (*VectorsClient) DeleteBucketPolicy

func (c *VectorsClient) DeleteBucketPolicy(ctx context.Context, request *DeleteBucketPolicyRequest, optFns ...func(*oss.Options)) (*DeleteBucketPolicyResult, error)

DeleteBucketPolicy Deletes a policy for a vector bucket.

func (*VectorsClient) DeleteVectorBucket

func (c *VectorsClient) DeleteVectorBucket(ctx context.Context, request *DeleteVectorBucketRequest, optFns ...func(*oss.Options)) (*DeleteVectorBucketResult, error)

DeleteVectorBucket Deletes a vector bucket.

func (*VectorsClient) DeleteVectorIndex

func (c *VectorsClient) DeleteVectorIndex(ctx context.Context, request *DeleteVectorIndexRequest, optFns ...func(*oss.Options)) (*DeleteVectorIndexResult, error)

DeleteVectorIndex Deletes a vector index.

func (*VectorsClient) DeleteVectors

func (c *VectorsClient) DeleteVectors(ctx context.Context, request *DeleteVectorsRequest, optFns ...func(*oss.Options)) (*DeleteVectorsResult, error)

DeleteVectors Deletes a vector.

func (*VectorsClient) GetBucketLogging

func (c *VectorsClient) GetBucketLogging(ctx context.Context, request *GetBucketLoggingRequest, optFns ...func(*oss.Options)) (*GetBucketLoggingResult, error)

GetBucketLogging Queries the configurations of access log collection of a vector bucket.

func (*VectorsClient) GetBucketPolicy

func (c *VectorsClient) GetBucketPolicy(ctx context.Context, request *GetBucketPolicyRequest, optFns ...func(*oss.Options)) (*GetBucketPolicyResult, error)

GetBucketPolicy Queries the policies configured for a vector bucket.

func (*VectorsClient) GetVectorBucket

func (c *VectorsClient) GetVectorBucket(ctx context.Context, request *GetVectorBucketRequest, optFns ...func(*oss.Options)) (*GetVectorBucketResult, error)

GetVectorBucket Queries information about a bucket.

func (*VectorsClient) GetVectorIndex

func (c *VectorsClient) GetVectorIndex(ctx context.Context, request *GetVectorIndexRequest, optFns ...func(*oss.Options)) (*GetVectorIndexResult, error)

GetVectorIndex Get a vector Index.

func (*VectorsClient) GetVectors

func (c *VectorsClient) GetVectors(ctx context.Context, request *GetVectorsRequest, optFns ...func(*oss.Options)) (*GetVectorsResult, error)

GetVectors Get a vector.

func (*VectorsClient) InvokeOperation

func (c *VectorsClient) InvokeOperation(ctx context.Context, input *oss.OperationInput, optFns ...func(*oss.Options)) (*oss.OperationOutput, error)

func (*VectorsClient) ListVectorBuckets

func (c *VectorsClient) ListVectorBuckets(ctx context.Context, request *ListVectorBucketsRequest, optFns ...func(*oss.Options)) (*ListVectorBucketsResult, error)

ListVectorBuckets Lists vector buckets that belong to the current account.

func (*VectorsClient) ListVectorIndexes

func (c *VectorsClient) ListVectorIndexes(ctx context.Context, request *ListVectorIndexesRequest, optFns ...func(*oss.Options)) (*ListVectorIndexesResult, error)

ListVectorIndexes Lists vector indexes that belong to the current account.

func (*VectorsClient) ListVectors

func (c *VectorsClient) ListVectors(ctx context.Context, request *ListVectorsRequest, optFns ...func(*oss.Options)) (*ListVectorsResult, error)

ListVectors Lists vectors that belong to the current account.

func (*VectorsClient) NewListVectorBucketsPaginator

func (c *VectorsClient) NewListVectorBucketsPaginator(request *ListVectorBucketsRequest, optFns ...func(*oss.PaginatorOptions)) *ListVectorBucketsPaginator

func (*VectorsClient) NewListVectorIndexesPaginator

func (c *VectorsClient) NewListVectorIndexesPaginator(request *ListVectorIndexesRequest, optFns ...func(*oss.PaginatorOptions)) *ListVectorIndexesPaginator

func (*VectorsClient) NewListVectorsPaginator

func (c *VectorsClient) NewListVectorsPaginator(request *ListVectorsRequest, optFns ...func(*oss.PaginatorOptions)) *ListVectorsPaginator

func (*VectorsClient) PutBucketLogging

func (c *VectorsClient) PutBucketLogging(ctx context.Context, request *PutBucketLoggingRequest, optFns ...func(*oss.Options)) (*PutBucketLoggingResult, error)

PutBucketLogging Enables logging for a vector bucket.

func (*VectorsClient) PutBucketPolicy

func (c *VectorsClient) PutBucketPolicy(ctx context.Context, request *PutBucketPolicyRequest, optFns ...func(*oss.Options)) (*PutBucketPolicyResult, error)

PutBucketPolicy Configures a policy for a vector bucket.

func (*VectorsClient) PutVectorBucket

func (c *VectorsClient) PutVectorBucket(ctx context.Context, request *PutVectorBucketRequest, optFns ...func(*oss.Options)) (*PutVectorBucketResult, error)

PutVectorBucket Creates a vector bucket.

func (*VectorsClient) PutVectorIndex

func (c *VectorsClient) PutVectorIndex(ctx context.Context, request *PutVectorIndexRequest, optFns ...func(*oss.Options)) (*PutVectorIndexResult, error)

PutVectorIndex Creates a vector Index.

func (*VectorsClient) PutVectors

func (c *VectorsClient) PutVectors(ctx context.Context, request *PutVectorsRequest, optFns ...func(*oss.Options)) (*PutVectorsResult, error)

PutVectors Creates a vector.

func (*VectorsClient) QueryVectors

func (c *VectorsClient) QueryVectors(ctx context.Context, request *QueryVectorsRequest, optFns ...func(*oss.Options)) (*QueryVectorsResult, error)

QueryVectors Query a vector.

Jump to

Keyboard shortcuts

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